2
Installing and Configuring OracleAS TopLink

This chapter includes the following information to install Oracle Application Server TopLink:

OracleAS TopLink Installation Types

The Oracle Universal Installer for OracleAS TopLink provides four different installation types. The installation types is a pre-defined component set within the Oracle Universal Installer that automatically selects which components to install. The Installation types that appear in the Oracle Universal Installer screen depend on the list that the installation developer specified for this particular product.

The four installation types include:

Complete

This option installs the entire product, including OracleAS TopLink Foundation Library, OracleAS TopLink Mapping Workbench, OracleAS TopLink Sessions Editor and OracleAS TopLink Examples.

Mapping and Code Development

This option installs the OracleAS TopLink Foundation Library, OracleAS TopLink Mapping Workbench and OracleAS TopLink Sessions Editor.

Code Development

This option installs the OracleAS TopLink Foundation Library for development without the OracleAS TopLink Mapping Workbench and OracleAS TopLink Sessions Editor.

Runtime

This option installs only the packaged runtime classes.

Installing OracleAS TopLink

Use the following procedures to install OracleAS TopLink (including the OracleAS TopLink Foundation Library and OracleAS TopLink Mapping Workbench). Before you install OracleAS TopLink, back up all existing project data.

Note:

If you are upgrading from a version previous to Release 2 (9.0.3), you must convert the package names before you open your OracleAS TopLink project(s) in 10g (9.0.4). Refer to "Package Rename" for more information.

Installing OracleAS TopLink on Windows Operating System

To start the Oracle Universal Installer and install OracleAS TopLink on a Windows Operating System, proceed as follows:

Ensure that you are logged in to the computer as a member of the Windows Administrators group.

Note:

When you configure OracleAS TopLink for use with J2EE containers, you will also need to modify the System Variables--not the User Variables.

Java package names are case-sensitive. When you install under Windows, make sure case sensitivity is turned on.

For more information, consult your Microsoft Windows documentation.

Insert the OracleAS TopLink installation disk into the CD-ROM drive to launch Oracle Universal Installer.
- If your computer supports the auto run feature, the installer will automatically launch on your computer.
- If your computer does not support the auto run feature, perform the following steps to launch the installer:
1. Locate the following file:
  
  G:\setup.exe, where G is the letter for your CD-ROM drive.
2. Launch the setup.exe program to start the installer.
  
  This launches the Oracle Universal Installer with which you can install OracleAS TopLink.

When the installation is complete, verify and if necessary edit the JDBC_CLASSPATH variable in the <ORACLE_HOME>\toplink\bin\setenv.cmd file. The JDBC_CLASSPATH variable must specify the path to the preferred JDBC driver(s).

Caution:

The JDBC_CLASSPATH variable must not include any Java classes for your persistent business objects that are specified in an OracleAS TopLink Mapping Workbench project. Paths for persistent business objects are set within an OracleAS TopLink Mapping Workbench project.

For more information on how to set up a path for a project, see the Oracle Application Server TopLink Mapping Workbench User's Guide.

Refer to <ORACLE_HOME>\toplink\doc\index.htm for the latest Oracle Application Server TopLink Release Notes.

Silent Installation on Windows Operating System

Silent installation mode is available for all installation types. You can make use of the silent installation when you wish to make multiple installations simultaneously or when you perform installations from a remote location. Silent installation eliminates the need to monitor the installation because there is no graphical output and no input by the user.

Insert the OracleAS TopLink installation disk into the CD-ROM drive.
Open the \Stage\Response directory and select the oracle.toplink.Installation_Type.rsp file.
Copy the oracle.toplink.Installation_Type.rsp file to a temp folder.
Edit the following parameters in the oracle.toplink.Installation_Type.rsp file:

ORACLE_HOME

ORACLE_HOME_NAME

FROM_LOCATION
Open a command prompt window and enter setup.exe -responseFile C:\temp\oracle.toplink.Installation_Type.rsp -silent and press Enter.
If your installation was successful, the silentInstall.log file contains the following line:

"The installation of OracleAS TopLink was successful."

Installing OracleAS TopLink on UNIX or other non-Windows Operating System

To start the Oracle Universal Installer and install OracleAS TopLink on UNIX or other non-Windows Operating System, proceed as follows:

Insert the OracleAS TopLink installation disk into the CD-ROM.
Run Oracle Universal Installer from the CD-ROM and follow the Oracle Universal Installer instructions.

Note:
Be sure you are not logged in as the root user when you start the Oracle Universal Installer. If you are, then only the root user will have permissions to manage OracleAS TopLink.
1. Log in as the oracle user.
2. To start the installer enter:
  
  prompt> mount_point/as_904disk/runInstaller.
  
  This launches the Oracle Universal Installer with which you install OracleAS TopLink.
  
  Note:
  Do not start the installation inside the mount_point directory. If you do, then you may not be able to eject the installation disk.

When the installation is complete, verify and if necessary edit the JDBC_CLASSPATH variable in the setenv.sh file. The JDBC_CLASSPATH variable must specify the path to the preferred JDBC driver(s).

You can find the setenv.sh file in the <ORACLE_HOME>/toplink/bin directory.

Caution:

For more information on how to set up a path for a project, see the Oracle Application Server TopLink Mapping Workbench User's Guide.

Refer to <ORACLE_HOME>/toplink/doc/index.htm for the latest Oracle Application Server TopLink Release Notes.

Silent Installation on UNIX or other non-Windows Operating System

Insert the OracleAS TopLink installation disk into the CD-ROM drive.
Open the /Stage/Response directory and select the oracle.toplink.Installation_Type.rsp file.
Copy the oracle.toplink.Installation_Type.rsp file to a tmp folder.
Edit the following parameters in the oracle.toplink.Installation_Type.rsp file:

ORACLE_HOME

ORACLE_HOME_NAME

GROUP_NAME

FROM_LOCATION
Open a command prompt window and enter ./runInstaller -responseFile /tmp/oracle.toplink.Installation_Type.rsp -silent and press Enter.
If your installation was successful, the silentInstall.log file contains the following line:

"The installation of OracleAS TopLink was successful."

Configuring the OracleAS TopLink Examples

The complete OracleAS TopLink installation includes the OracleAS TopLink Examples. These examples help users explore and learn about how to use the OracleAS TopLink features with different architectures and different technologies. They are designed to be as simple as possible while still effectively demonstrating the target architecture, technology, or feature.

There are two types of examples: application server and OracleAS TopLink Foundation Library (non-server) examples.

Application server examples vary from server to server, depending on the server-specific features. Although OracleAS TopLink provides instructions for certain servers, you can run many of the examples (for example, the Session Bean and Servlet JSP examples) on other application servers with some configuration changes.
OracleAS TopLink Foundation Library (non-server) examples are configured to run in a simple Java VM, but the features and technologies they demonstrate can also be used in an application server environment.

When you run the examples, useful information is written to standard out, including details about what the example is doing and what SQL is generated. You may find it useful to redirect standard out to a file when you run an example

Although the OracleAS TopLink Examples require little configuration, ensure that you read and verify the configuration details included in the Configuring the Examples document before you run the Examples. For more information on how to run and configure the examples, see Configuring the Examples at
<ORACLE_HOME>\toplink\doc\examples\config\config.htm.

When configuration is complete, each of the OracleAS TopLink Examples has a ReadMe file with specific information on how to build and run the example.

Configuring OracleAS TopLink for Oracle JDeveloper

This section contains information on how to configure OracleAS TopLink for Oracle JDeveloper.

Oracle JDeveloper is a J2EE development environment with end-to-end support to develop, debug, and deploy e-business applications and Web Services.

When you use OracleAS TopLink with Oracle JDeveloper, use the following procedures to add the OracleAS TopLink JAR files to your JDeveloper projects:

Creating an OracleAS TopLink JDeveloper Library:

Select a JDeveloper project in the System Navigator pane.
Select Project, choose Project Settings.

The Project Settings pane appears.
Select Configurations, choose Development, then choose Libraries.

A list of pre-defined and user-defined libraries appears.
Click New to create a new library which will contain the OracleAS TopLink .jar files.

The New Library dialog box appears.
Enter a name for the new Library--for example, OracleAS TopLink.

Ensure that the default choice for Libraries remains as User Libraries.
To edit the Class Path and add the OracleAS TopLink .jar files, click the Edit button.

Add the following to the beginning of your Class Path:
```
<ORACLE_HOME>\toplink\jlib\toplink.jar
<ORACLE_HOME>\toplink\jlib\antlr.jar
<ORACLE_HOME>\lib\xmlparserv2.jar
```
Click OK. On the Project Settings pane click OK.

Use an existing User-Defined OracleAS TopLink Library:

After a user library is created, it can be re-referenced by any other project. Revisit the Libraries window of the Project Settings, and add the OracleAS TopLink Library to any project with which you want to use OracleAS TopLink.

Sun JDK and JRE

On a Windows-based platform, OracleAS TopLink includes the Java Runtime Environment 1.4.2 from Sun Microsystems for use by the OracleAS TopLink Mapping Workbench.

To configure OracleAS TopLink for a different version of the JRE, change the setenv.cmd to point JRE_HOME to the alternate directory.

At runtime, the OracleAS TopLink Foundation Library requires a JVM compatible with JDK 1.3 or higher.

To compile and run the OracleAS TopLink Examples, you must have a Java 2 SDK installed. For more information on how to configure and run the OracleAS TopLink Examples, see "Configuring the OracleAS TopLink Examples".

Java Cryptography Extension (JCE)

The OracleAS TopLink Mapping Workbench and OracleAS TopLink Sessions Editor use JCE to encrypt database login information. JCE is included with JDK 1.4. If you use JDK 1.3.1 or higher, select one of the following options:

Download and install the Sun JCE plug-in from http://java.sun.com/products/jce/.
Do not store password information in the OracleAS TopLink Mapping Workbench or OracleAS TopLink Sessions Editor. Instead, manually add the password in code or edit the generated project file.

General Troubleshooting

After you install OracleAS TopLink, if you encounter problems either starting the application or connecting to a database, try the following solutions:

Ensure that the driver class name is correct. Many vendors have several different driver classes to choose from.
Check your login information.
Ensure that your path includes all .dll files your driver requires.
Check with your database administrator that:
- Any drivers that require special set-up in the database server (such as Sybase JConnect) have been set up correctly.
- Any drivers that require special permissions in the database server have been set up correctly.
- You are not exceeding the number of available concurrent connections to your database. This may occur during development time, when many people are testing connections.
If you use database servers that requires an extra Windows NT service to be running for JDBC connections, ensure that one is running.
Check with your vendor to ensure that you are using the latest version of both your JDBC driver and the database to which it is connecting.

Installing Patch Sets

The 10g (9.0.4) release includes changes introduced in previously released patch sets for Release 2 (9.0.3.), namely:

Release 2 (9.0.3.1)
Release 2 (9.0.3.2)
Release 2 (9.0.3.3)
Release 2 (9.0.3.4)

When available, you can download the latest patch sets for 10g (9.0.4) from OracleMetaLink at

http://metalink.oracle.com

OracleMetaLink is the Oracle Support Services site where customers can get information about released patches and outstanding bugs.

2 Installing and Configuring OracleAS TopLink