|
Oracle® Business Intelligence Beans Setting Up a Separate OC4J Instance for Oracle Business Intelligence Beans Applications
10g Release 2 (10.1.2.1) for Microsoft Windows and Solaris Operating System Part No. B19326-01 |
|
Setting Up a Separate OC4J Instance for Oracle Business Intelligence Beans Applications
10g Release 2 (10.1.2.1) for Microsoft Windows and Solaris Operating System
Part No. B19326-01
September 2005
Use this document only if you want to deploy applications created by Oracle Business Intelligence Beans 10g Release 2 (10.1.2.1) (hereinafter referred to as "BI Beans") to Oracle Application Server 10g (9.0.4).
The following list describes the sections of this document:
Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at
http://www.oracle.com/accessibility/
Accessibility of Code Examples in Documentation
Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.
Accessibility of Links to External Web Sites in Documentation
This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.
TTY Access to Oracle Support Services
Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.
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.
Note: 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.
Regardless of whether you will run your application in Windows or UNIX, you require a WAR deployment profile for the application.
To deploy a BI Beans 10g Release 2 (10.1.2.1) application to Oracle Application Server 10g (9.0.4), create a new WAR deployment profile (for example, webapp.war) in Oracle JDeveloper. 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.
The following list describes the topics in this section:
Section 4.1, "Naming Conventions Used in Procedures on Windows"
Section 4.2, "Setting Up and Configuring a Separate OC4J Instance on Windows"
Section 4.3, "Configuring the Oracle JDBC Thick (OCI) Driver 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.
To deploy a BI Beans 10g Release 2 (10.1.2.1) 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.
-Xmx256m -Djava.ext.dirs=oas_home/jdk/jre/lib/ext;new_oc4j_instance/jdbc -Doc4j.userThreads=true
Click Apply.
On the Confirmation page, click OK.
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 when you entered parameters in the Command Line Options section.
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.
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.
Add the PATH variable as follows:
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
Note: The database path must be the first value.
Add the LIB variable as follows:
Click Add Environment Variable. A 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: The database path must be the first value.
Add the ORACLE_HOME variable as follows:
Click Add Environment Variable again. A 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\ oracledb).
Add the ORA_NLS33 variable as follows:
Click Add Environment Variable. A 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."
The following list describes the topics in this section:
Section 5.1, "Naming Conventions Used in Procedures on UNIX"
Section 5.2, "Setting Up and Configuring a Separate OC4J Instance on UNIX"
Section 5.3, "Configuring the Oracle JDBC Thick (OCI) Driver on UNIX"
The UNIX 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, /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.
To deploy a BI Beans 10g Release 2 (10.1.2.1) 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.
-Xmx256m -Djava.ext.dirs=oas_home/jdk/jre/lib/ext:new_oc4j_instance/jdbc -Doc4j.userThreads=true
Click Apply.
On the Confirmation page, click OK.
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 when you entered parameters in the Command Line Options section.
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_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.
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/ 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.
Add the PATH variable as follows:
In the Environment Variables section, click 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/ oracledb/bin:/users/ora_oas/bin.
Note: The database path must be the first value.
Add the LD_LIBRARY_PATH variable as follows:
In the Environment Variables section, click Add Environment Variable. A new Name/Value pair is added to the Environment Variables table.
Enter LD_LIBRARY_PATH in the Name field.
In the Value field, enter the following: /users/ oracledb/lib:/users/ora_oas/lib.
Note: The database path must be the first value.
Add the ORACLE_HOME variable as follows:
In the Environment Variables section, click Add Environment Variable. A new Name/Value pair is added to the Environment Variables table.
Enter ORACLE_HOME in the Name field.
In the Value field, enter the value of the $ORACLE_HOME environment variable (for example, /users/ oracledb).
Add the ORA_NLS33 variable as follows:
In the Environment Variables section, click Add Environment Variable. A new Name/Value pair is added to the Environment Variables 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/ oracledb, then the value would be /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 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."
Setting Up a Separate OC4J Instance for Oracle Business Intelligence Beans Applications, 10g Release 2 (10.1.2.1) for Microsoft Windows and Solaris Operating System
Part No. B19326-01
Copyright © 2005 Oracle. All rights reserved.
The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software—Restricted Rights (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.
Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.