Oracle is a registered trademark and Oracle9i is a trademark or registered
trademark of Oracle Corporation. Other names may be trademarks of their respective
owners.
Oracle Business Intelligence Beans
Setting Up a Separate OC4J Instance for BI Beans Applications
January 2005
Use this document only if you want to deploy applications created by Oracle Business Intelligence Beans 10g (10.1.2) (hereinafter referred to as "BI Beans") to Oracle Application Server 10g (9.0.4).
BI Beans requires the Oracle Database 10g version
of JDBC drivers, while Oracle Application Server 10g (9.0.4), by default,
uses an earlier version of these drivers. An instance of Oracle Application Server Containers
for J2EE (OC4J) can use only one version of the JDBC drivers. Therefore, to deploy
a BI Beans application to the same Oracle Application Server as other applications,
you must create a separate instance of OC4J.
This document describes the process
of configuring a separate instance of OC4J for Windows and UNIX platforms.
You may also want to consult Oracle Application Server Containers for J2EE
User's Guide, which is available as part of the Oracle Application Server documentation.
Notes:
BI Beans 10.1.2 supports the use of either Oracle9i Release 2 database
(9.2.0.5 for Windows or 9.2.0.6 for all platforms) or Oracle Database 10g (10.1.0.3).
In general, Oracle Application Server 10g (9.0.4) components and
applications are not certified using the 10g JDBC drivers. However,
BI Beans is certified for using the 10g JDBC drivers.
Part 1: Creating a WAR deployment profile in JDeveloper
In Oracle JDeveloper, to deploy a BI Beans 10.1.2 application to Oracle Application Server 10g (9.0.4), create a new WAR deployment profile (for example, webapp.war). This deployment profile should include the following libraries under the Contributors node for WEB-INF/lib:
BIBeans Runtime
BC4J Runtime
OLAP API
Oracle JDBC
Note: It is essential that you include the Oracle JDBC library in this deployment profile.
Part 2: Creating a separate OC4J instance for Windows
This part of the document contains the following sections:
Naming conventions used in procedures on Windows
Setting up and configuring a separate OC4J instance on Windows
Configuring the Oracle JDBC Thick (OCI) driver on Windows
Naming conventions used in procedures on Windows
The Windows section of this document uses the following names to refer to certain files and directories:
oracle_home -- The full path to your Oracle Home directory.
oas_home -- The directory where Oracle Application Server is installed (for example, d:\users\ora_oas).
oc4j_bibeans -- The name of the new OC4J instance that you are creating.
new_oc4j_instance -- The location of the new OC4J instance. The new directory that contains
the OC4J instance has the same name as the instance and is under
oas_home\j2ee. That is, new_oc4j_instance is equivalent
to oas_home\j2ee\oc4j_bibeans. For example, if Oracle Application Server is
installed in d:\oas and the OC4J instance is named
my_oc4j, then new_oc4j_instance will be
d:\oas\j2ee\my_oc4j.
Setting up and configuring a separate OC4J instance on Windows
To deploy a BI Beans 10g (10.1.2) application to Oracle Application
Server 10g (9.0.4) on a Windows platform, set up and configure a separate instance of OC4J
as follows:
Create a new OC4J instance:
Log in to Oracle Enterprise Manager for Oracle Application Server. Oracle
Enterprise Manager is installed as part of Oracle Application Server 10g
(9.0.4).
Navigate to the home page of the Oracle Application Server where you
want to create the OC4J instance.
In the System Components section, click Create OC4J
Instance.
In the OC4J instance name field, enter the new OC4J instance name, then
click Create.
Click OK to acknowledge the confirmation
message. You will see the new instance name in the Application Server
System Components section. You can go to the home page of the instance
by clicking its link.
Update the VM level properties of the OC4J instance as follows:
Still in Oracle Enterprise Manager, navigate to the oc4j_bibeans home page and click Administration.
In the Instance Properties section, click Server
Properties.
In the Command Line Options section, add the following parameters to
the Java Options field. The parameters to add are listed separately here,
for clarity, but in the Java Options field, they can follow one another
on the same line, delimited by spaces..
Remove references to three library paths to ensure that your application
uses the files that are packaged with it rather than those that are packaged
with OC4J:
Navigate back to the home page of the oc4j_bibeans
instance and click Applications.
In the Default Application Name field, click default.
In the Administration area, under Properties, click General.
In the Library Paths section, in the Select Path box, select ..\..\..\BC4J\lib
and click Delete.
In the Select Path box, select ..\..\..\jlib\uix2.jar and
click Delete.
In the Select Path box, select ..\..\..\jlib\share.jar and
click Delete.
Click Apply.
On the Confirmation page, click OK. Do not
close Oracle Enterprise Manager.
Log in to the machine where you created the oc4j_bibeans
instance. You must log in as the user who installed Oracle Application Server.
Create a new directory named jdbc under new_oc4j_instance.
This is the name you specified in the -Djava.ext.dirs option
in Step 2.
Copy the JDBC driver files (classes12.jar, classes12dms.jar,
and nls_charset12.jar) to this new directory. The correct source
for these files differs, depending on which type of JDBC driver you are
using.
If you are using the Oracle JDBC Thin (Pure Java) driver, then copy the
files from the $ORACLE_HOME\bibeans\jdbc\lib directory in
the BI Beans installation.
If you are using the Oracle JDBC Thick
(OCI) driver, then copy the files from the Oracle9i or Oracle
Database 10g client or server installation. When
you use the thick driver, the version of the JDBC driver files must
match the version of the database client. The files are located in the
$ORACLE_HOME\jdbc\lib directory, where $ORACLE_HOME
is the Oracle Home for the database.
Return to Oracle Enterprise Manager and click Application
Server Instance.
Select the oc4j_bibeans instance from the list and
click Start. You are now ready to deploy your
BI Beans 10.1.2 application.
Configuring the Oracle JDBC Thick (OCI) driver on Windows
If you want to use the Oracle JDBC Thick (OCI) driver on a Windows platform, follow the instructions in this section.
In order to use the Oracle JDBC Thick (OCI) driver, either the Oracle9i
Release 2 database (client, server, or both) or the Oracle Database 10g
(client, server, or both) must reside on the machine where Oracle Application
Server 10g is installed. You need to know the full path to this database installation. Specifically, note the values for the following environment variables: ORACLE_HOME, ORA_NLS33, PATH, and LIB. This is also the correct location of the JDBC
driver files, whose version must match that of the database client.
The following procedure assumes that Oracle Application Server is installed
under d:\users\ora_oas and that Oracle9i Release 2 (client, server, or both) or Oracle Database 10g (client, server, or both)
is installed under d:\users\oracledb.
Log in to Oracle Enterprise Manager for Oracle Application Server.
Navigate to the oc4j_bibeans home page and click Administration.
In the Instance Properties section, click Server Properties.
In the Environment Variables section, choose Add Environment
Variable. A new Name/Value pair is added to the Environment Variables
table.
Enter PATH in the Name field.
In the Value field, enter the following: d:\users\oracledb\bin;d:\users\ora_oas\bin
Click Add Environment Variable again. Another
new Name/Value pair is added to the table.
Enter LIB in the Name field.
In the Value field, enter the following: d:\users\oracledb\lib;d:\users\ora_oas\lib
Note: In both the path properties (PATH and
LIB), the database path must be the first value.
Click Add Environment Variable again. Another
new Name/Value pair is added to the table.
Enter ORACLE_HOME in the Name field.
In the Value field, enter the value of the ORACLE_HOME environment variable
(for example, d:\users\oracle92).
Click Add Environment Variable again. Another
new Name/Value pair is added to the table.
Enter ORA_NLS33 in the Name field.
In the Value field, enter the following: oracle_home\ocommon\nls\admin\data
For example, if your Oracle home directory is d:\users\oracledb,
then the value would be the following: d:\users\oracledb\ocommon\nls\admin\data
Click Apply.
On the Confirmation page, click OK to restart
the oc4j_bibeans instance.
Set the value of the JdbcDriverType to oci8
(for Oracle9i database) or to oci (for Oracle Database
10g) in each BI Beans application's configuration file, as described
in the BI Beans Help topic "Requirements for the Deployment Environment."
Part 3: Creating a separate OC4J instance for UNIX
This part of the document contains the following sections:
Naming conventions used in procedures on UNIX
Setting up and configuring a separate OC4J instance on UNIX
Configuring the Oracle JDBC Thick (OCI) driver on UNIX
Naming conventions used in procedures on UNIX
The UNIX section of this document uses the following names to refer to certain files and directories:
oas_home -- The directory where Oracle Application Server is installed (for example, /users/ora_oas).
oc4j_bibeans -- The name of the new OC4J instance that you are creating.
new_oc4j_instance -- The path to the location of the new OC4J instance. The new directory that contains the OC4J instance has the same name as the instance and is under oas_home/j2ee. That is, new_oc4j_instance is equivalent to oas_home/j2ee/oc4j_bibeans.
Setting up and configuring a separate OC4J instance on UNIX
To deploy a BI Beans 10g (10.1.2) application to Oracle Application Server 10g (9.0.4), set up and configure a separate instance of OC4J as follows:
Create a new OC4J instance:
Log in to Oracle Enterprise Manager for Oracle Application Server. Oracle Enterprise Manager is installed as part of Oracle Application Server 10g (9.0.4).
Navigate to the home page of the Oracle Application Server where you want to create the OC4J instance.
In the System Components section, click Create OC4J Instance.
In the OC4J instance name field, enter the new OC4J instance name, then click Create.
Click OK to acknowledge the confirmation message. You will see the new instance name in the Application Server System Components section. You can go to the home page of the instance by clicking its link.
Update the VM level properties of the OC4J instance as follows:
Still in Oracle Enterprise Manager, navigate to the oc4j_bibeans home page and click Administration. In the Instance Properties section, click Server Properties.
In the Command Line Options section, add the following parameters to the Java Options field. The parameters to add are listed separately here, for clarity, but in the Java Options field, they can follow one another on the same line, delimited by spaces.
Remove references to three library paths to ensure that your application uses the files that are packaged with it rather than those that are packaged with OC4J:
Navigate back to the home page of the oc4j_bibeans instance and click Applications.
In the Default Application Name field, click default.
In the Administration area, under Properties, click General.
In the Library Paths section, in the Select Path box, select ../../../BC4J/lib and click Delete.
In the Select Path box, select ../../../jlib/uix2.jar and click Delete.
In the Select Path box, select ../../../jlib/share.jar and click Delete.
Click Apply.
On the Confirmation page, click OK. Do not close Oracle Enterprise Manager.
Log in to the machine where you created the oc4j_bibeans instance. You must log in as the user who installed Oracle Application Server.
Create a new directory named jdbc under new_oc4j_instance. This is the name you specified in the -Djava.ext.dirs option in Step 2.
Copy the JDBC driver files (classes12.jar, classes12dms.jar, and nls_charset12.jar) to this new directory. The correct source for these files differs, depending one which type of JDBC driver you are using.
If you are using the Oracle JDBC Thin (Pure Java) driver, then copy the files from the $ORACLE_HOME/bibeans/jdbc/lib_92 directory in the BI Beans installation. Do not use the files that are installed with JDeveloper.
If you are using the Oracle JDBC Thick (OCI) driver, then copy the files from the Oracle9i or Oracle Database 10g client or server installation. When you use the thick driver, the version of the JDBC driver files must match the version of the database client. The files are located in the $ORACLE_HOME/jdbc/lib directory, where $ORACLE_HOME is the Oracle Home for the database.
Return to Oracle Enterprise Manager and click Application Server Instance.
Select the oc4j_bibeans instance from the list and click Start. You are now ready to deploy your Oracle BI Beans 10g (9.0.4) application.
Configuring the Oracle JDBC Thick (OCI) driver on UNIX
If you want to use the Oracle JDBC Thick (OCI) driver on a UNIX platform, then follow the instructions in this section.
In order to use the Oracle JDBC Thick (OCI) driver, either the Oracle9i Release 2 database (client, server, or both) or the Oracle Database 10g (client, server, or both) must be on the machine where Oracle Application Server 10g is installed. This is also the correct location of the JDBC driver files, whose version must match that of the database client.
The following procedure assumes that Oracle Application Server is installed under /users/ora_oas and that Oracle9i Release 2 (client, server, or both) or Oracle Database 10g (client, server, or both) is installed under /users/oracle92.
Log in to Oracle Enterprise Manager for Oracle Application Server.
Navigate to the oc4j_bibeans home page and click Administration.
In the Instance Properties section, click Server Properties.
In the Environment Variables section, choose Add Environment Variable. A new Name/Value pair is added to the Environment Variables table.
Enter PATH in the Name field.
In the Value field, enter the following: /users/oracle92/bin:/users/ora_oas/bin
Click Add Environment Variable again. Another new Name/Value pair is added to the table.
Enter LD_LIBRARY_PATH in the Name field.
In the Value field, enter the following: /users/oracle92/lib:/users/ora_oas/lib
Note: In both the path properties (PATH and LD_LIBRARY_PATH), the database path must be the first value.
Click Add Environment Variable again. Another new Name/Value pair is added to the table.
Enter ORACLE_HOME in the Name field.
In the Value field, enter the value of the $ORACLE_HOME environment variable (for example, /users/oracle92).
Click Add Environment Variable again. Another new Name/Value pair is added to the table.
Enter ORA_NLS33 in the Name field.
In the Value field, enter the following: $ORACLE_HOME/ocommon/nls/admin/data. For example, if your Oracle home directory is /users/oracle92, then the value would be /users/oracle92/ocommon/nls/admin/data.
Click Apply.
On the Confirmation page, click OK to restart the oc4j_bibeans instance.
Set the value of the JdbcDriverType to oci8 (for Oracle 9i database) or to oci (for Oracle Database 10g) in each Oracle BI Beans application's configuration file, as described in the BI Beans Help topic "Requirements for the Deployment Environment."