# Installation Guide

# Preparing for Your Installation

The following sections provide information that you need to know before installing your BEA WebLogic Real Time™ software:

- Installation Overview
- Installable Product Components
- Product Distribution Methods
- Installation Prerequisites
- Selecting Directories for Your Installation
- Choosing the Type of Installation
- About Installing Node Manager as a Windows Service
- Generating a Verbose Installation Log

## Installation Overview

The WebLogic Real Time installation program provides a complete framework for the installation and uninstallation of WebLogic Real Time or individual components, as desired.

### Installation Modes

The WebLogic Real Time installation program can be used in the following modes:

- Graphical mode

Graphical-mode installation is an interactive, GUI-based method for installing your software. It can be run on both Windows and Linux systems. For installation procedures, see Running the Installation Program in Graphical Mode.

Note: | If you want to run graphical-mode installation, the console attached to the machine on which you are installing the software must support a Java-based GUI. All consoles for Windows systems support Java-based GUIs, but not all consoles for Linux systems do. If you attempt to start the installation program in graphical mode on a system that cannot support a graphical display, the installation program automatically starts console-mode installation.

- Console mode

Console-mode installation is an interactive, text-based method for installing your software from the command line, on either a Linux system or a Windows system. For instructions for using this method, see Running the Installation Program in Console Mode.

- Silent mode

Silent-mode installation is a noninteractive method of installing your software that requires the use of an XML properties file for selecting installation options. You can run silent-mode installation in either of two ways: as part of a script or from the command line. Silent-mode installation is a way of setting installation configurations only once and then using those configurations to duplicate the installation on many machines. For instructions, see Running the Installation Program in Silent Mode.

## Installable Product Components

Using the WebLogic Real Time 1.0 installation program, you can install the following software on your system:

- WebLogic Real Time
- WebLogic Server

For additional information about:

- The features and capabilities of WebLogic Real Time, see Introduction to WebLogic Real Time at`http://download.oracle.com/docs/cd/E13221_01/wlrt/docs10/wlrt_intro/index.html`
- The features and capabilities of WebLogic Server, see Introduction to WebLogic Server and WebLogic Express at`http://download.oracle.com/docs/cd/E13222_01/wls/docs91/intro/index.html`
- The features and capabilities of BEA JRockit, see Introduction to JRockit JDK at `http://download.oracle.com/docs/cd/E13188_01/jrockit/geninfo/genintro/index.html`
- Operating systems and hardware supported by your software, see "WebLogic Real Time 1.0 Supported Configurations" at `http://download.oracle.com/docs/cd/E13221_01/wlrt/docs10/intro_wlrt/intro.html#wlrt_supported_configs`

### WebLogic Real Time

WebLogic Real Time's proprietary BEA JRockit JVM introduces "deterministic" garbage collection, a dynamic garbage collection priority that ensures extremely short pause times and limits the total number of those pauses within a prescribed window.

#### BEA JRockit JDK With Deterministic GC

The BEA JRockit® JDK provides tools, utilities, and a complete runtime environment for developing and running applications using the Java programming language. The BEA JRockit JDK includes the BEA JRockit Java Virtual Machine (JVM) with the BEA JRockit Deterministic Garbage Collection.

The BEA JRockit JVM is developed uniquely for server-side applications and optimized for Intel architectures to ensure reliability, scalability, and manageability for Java applications. BEA JRockit Mission Control is a tool set developed to monitor, manage, profile, and eliminate memory leaks in your Java applications.

The BEA JRockit JDK is fully integrated into the BEA Products installation program, in addition to being available as a standalone JDK. BEA JRockit is installed automatically when you use the BEA Products installation program to install your software on Windows and Linux 32-bit platforms.

For more information about the BEA JRockit JDK, see the JRockit documentation at `http://download.oracle.com/docs/cd/E13188_01/jrockit/webdocs/index.html`.

Note: | The BEA JRockit 5.0 JDK is certified to be compatible with Sun Java 2 Standard Edition (J2SE) version 5.0.

#### Mercury Profiling Tools

The Mercury profiling tools, which are provided as part of this JRockit installation, can be used by Java and J2EE developers in a development environment to profile application performance. During the installation process, you are presented with the option to install the Mercury profiling tools. If you do so, you are prompted to accept the Mercury Tools license agreement. You must accept the license agreement to install the tools. For more information about these tools, see `http://www.mercury.com/us/products/diagnostics/`.

### WebLogic Server

BEA WebLogic Server® provides the core services that ensure a reliable, available, scalable, and high-performing execution environment for your application. It includes Apache Beehive, a cross-container framework that provides a consistent, abstract, and easily toolable programming model, providing a way for developers to build applications more productively.

WebLogic Server consists of the following subcomponents that can be installed on your system:

- Server—WebLogic Server program files that contain the core Java 2 Enterprise Edition (J2EE) features and Apache Beehive.
- Server Examples—WebLogic Server and MedRec examples servers and sample applications. These servers and sample applications demonstrate a variety of J2EE features. Resources are provided to help you build, configure, and run each of the sample applications. You must install the Server subcomponent to install and use the Server Examples.
- Web Server Plug-ins—Modules used to enable WebLogic Server to communicate with applications deployed on Apache HTTP Server, Netscape Enterprise Server, or Microsoft Internet Information Server (IIS).

Note: | You must choose Custom installation to install the Web Server plug-ins. They are not installed by default in a complete installation.

## Product Distribution Methods

Your BEA software is distributed on both the BEA Web site and CD-ROM.

### Web Distribution

You can download your software from the BEA Web site at `http://commerce.bea.com`.

This includes the BEA Products installation program for WebLogic Real Time and WebLogic Server, which includes all of the software described in Installable Product Components.

### CD-ROM Distribution

If you purchased your software from your local sales representative, you will find the following items in the product box:

- CD-ROMs containing the product software for Windows and Linux
- BEA Software License and Limited Warranty pamphlet

## Installation Prerequisites

The following sections specify the installation prerequisites:

- System Requirements
- Temporary Disk Space Requirements
- Administrator Privileges
- Licensing

### System Requirements

The system requirements for your installation are given in the following table.

Table 1-1 System Requirements
Component | Requirement
--- | ---
Platform configuration | A supported configuration of hardware and operating system is required. See "WebLogic Real Time 1.0 Supported Configurations" at `http://download.oracle.com/docs/cd/E13221_01/wlrt/docs10/intro_wlrt/intro.html#wlrt_supported_configs`
Processor | 1-GHz CPU recommended
Hard disk drive | A complete installation requires approximately 820 MB of disk space.
Memory | 1 GB of RAM minimum
Color bit depth display and size | For graphical user interface (GUI) mode installation, 8-bit color depth (256 colors) is required. For console-mode and silent-mode installation, there is no color bit depth requirement.
JDK | The BEA Products installation program requires a Java run-time environment (JRE) to run. A JRE is bundled in the Windows installation program and in some Linux installation programs (those with filenames ending in `.bin`). For other Linux platforms, the installation program does not install a JDK. Filenames for these installation programs end in `.jar`. To run the `.jar` installation programs, you must have the appropriate version of the JDK installed on your system, and include the `bin` directory of the JDK at the beginning of the `PATH` variable definition. It is important that you use a JDK because the installation process assigns values to `JAVA_HOME` and related variables to point to the JDK directory.

### Temporary Disk Space Requirements

The BEA installation program uses a temporary directory into which it extracts the files necessary to install the software on the target system. During the installation process, your temporary directory must contain sufficient space to accommodate the compressed Java run-time environment (JRE) bundled with the installation program and an uncompressed copy of the JRE that is expanded into the temporary directory. The extracted files are deleted from the temporary directory at the end of the installation process. As a general rule, installation programs require approximately 2.5 times the amount of temporary space that is ultimately required by the installed files.

By default, the installation program uses the following temporary directories:

- Windows platforms—directory referenced by the `TMP` system variable
- Linux platforms—system-dependent temporary directory

Note: | If you do not have enough temporary space to run the installation program, you are prompted to specify an alternate directory or exit the installation program.

To make sure that you have adequate temporary space, you may want to allocate an alternate directory for this purpose. To do so, follow the instructions provided in the following table.

Table 1-2 Setting Temporary Disk Space
On this platform . . . | Perform this step . . .
--- | ---
Windows | Do one of the following: Set the `TMP` system variable to a directory of your choice. If starting the installation program from the command line, include the `-Djava.io.tmpdir=``tmpdirpath` option, replacing `tmpdirpath` with the full path of the directory that you want to designate as a temporary storage area for the BEA Products installation program. For example: `realtime100_win32.exe -mode=console -Djava.io.tmpdir=D:\Temp`
Linux | Enter the following option on the command line when you start the installation program: `-Djava.io.tmpdir=``tmpdirpath` Here, `tmpdirpath` is the full path of the directory that you want to designate as a temporary storage area for the BEA Products installation program.

### Administrator Privileges

On Windows systems, Administrator privileges are required in the following circumstances:

- To install the Node Manager as a Windows service.

You must have Administrator privileges to install the Node Manager as a Windows service. When the Node Manager is installed as a Windows service, it starts at the completion of the installation process, and again, automatically, each time you boot your Windows system.

For more information, see About Installing Node Manager as a Windows Service.

- To create Start menu shortcuts in the All Users folder.

When you are installing the software as a user with Administrator privileges, you are presented with the option to create the Start menu shortcuts in the All Users folder, or in the Local user's Start menu folder. The following table describes the options available.

Table 1-3 Creating Start Menu Shortcuts
If you select . . . | The following occurs . . .
--- | ---
All Users | All users registered on the machine are provided with access to the installed software. Subsequently, if users without Administrator privileges use the Configuration Wizard from this installation to create domains, Start menu shortcuts to the domains are not created. In this case, users can manually create shortcuts in their local Start menu folders, if desired.
Local user | Other users registered on this machine will not have access to the Start menu entries for this installation.

If a user without Administrator privileges installs the software, the Start menu entries are created in the user's local Start menu folder.

### Licensing

Your WebLogic Real Time software cannot be used without a valid license. When you install your software, the installation program installs a development license (`license.bea`) into the BEA Home directory, to allow you to start using the product immediately. However, for WebLogic Real Time 1.0, access to the BEA JRockit 5.0 "deterministic" garbage collection option requires an additional evaluation license key, as described in Updating Your WebLogic Real Time Product License.

To use your software in a full-scale production environment, you must purchase a production license. To find out how to do so, contact your sales representative or visit the BEA corporate Web site at `http://www.bea.com`.

For more information about development and production licenses, see About BEA Product Licenses.

Development and production licenses for pre-9.1 versions of WebLogic Server do not work with WebLogic Real Time 1.0; any such license must be upgraded to WebLogic Real Time 1.0. Procedures for upgrading a license file and installing permanent licenses are provided in Upgrading Licenses from Previous Software Releases.

## Selecting Directories for Your Installation

During the installation process, you need to specify locations for the following directories:

- BEA Home directory
- Product installation directory

### Choosing a BEA Home Directory

When you install your BEA software, you are prompted to specify a BEA Home directory. This directory serves as a repository for common files that are used by multiple WebLogic Real Time installed on the same machine. For this reason, the BEA Home directory can be considered a central support directory for all the WebLogic Real Time software installed on your system.

The files in the BEA Home directory are essential to ensuring that BEA software operates correctly on your system. They perform the following types of functions:

- Ensure that licensing works correctly for the installed BEA products
- Facilitate checking of cross-product dependencies during installation
- Facilitate Service Pack installation

The following illustration shows the structure of a sample BEA Home directory, on a Windows platform, which includes the BEA JRockit JDK.

This illustration depicts only the files and directories required in the BEA Home directory. If you choose the default product installation directory, however, you will see additional directories in the BEA Home directory, such as `realtime10`. Although the default location for the product installation directory is within the BEA Home, you can select a different location outside the BEA Home directory.

During installation of your BEA software, you are prompted to choose an existing BEA Home directory or specify a path to create a new BEA Home directory. If you choose to create a new directory, the installation program automatically creates it for you.

Notes: | BEA recommends that you do not exceed a maximum of 12 characters when naming your BEA Home directory. If the name of this directory has more than 12 characters, the `CLASSPATH` may not be resolved properly.

Note: | You can install only one instance of each version of a BEA product in a single BEA Home directory. For example, you can install only one instance of WebLogic Server 9.1 in a BEA Home directory, but that BEA Home directory may also contain an instance of WebLogic Server 9.0.

#### Understanding the Functions of the BEA Home Directory

The files and directories in the BEA Home directory are described in the following table.

Table 1-4 BEA Home Directory Description
Component | Description
--- | ---
`jrockit-realtime10``_xxx` directory | Contains the software for the BEA JRockit JDK if it is installed with your software. The JDK provides the Java run-time environment (JRE) and tools for compiling and debugging Java applications. In this directory name, `xxx` indicates the version of the JRockit JDK installed on your system, such as `jrockit-realtime10_150_04`.
`logs` directory | Contains a history file of installation and uninstallation for the BEA Home directory.
`utils` directory | Contains utilities that are used to support the installation of all BEA products installed in this BEA Home directory. The `utils.jar` file contains code that supports the `UpdateLicense` utility.
`license.bea` file | An XML file that contains the license keys for all the BEA products installed in the BEA Home directory. Licenses are release specific. For example, you cannot use a license from a previous release with WebLogic Real Time 1.0. To update your `license.bea` file for additional functionality, see Updating Your WebLogic Real Time Product License.
Note: | Do not edit the `license.bea` file manually. Doing so may cause operating problems for the currently installed BEA products, or result in problems later when BEA products are installed for maintenance upgrades.
`registry.xml` file | A registry file that contains a persistent record of all BEA products installed on the target system. This registry contains product-related information, such as version number, service pack number, and location of the installation directory.
Note: | Do not edit this file manually. Doing so may cause operating problems for the currently installed BEA products, or result in installation problems when future BEA products or maintenance upgrades are installed.
For more information about the BEA registry file, see "Using the BEA Registry API" in ISV Partners' Guide at the following URL: `http://download.oracle.com/docs/cd/E13179_01/common/docs91/isv/detect.html`
`UpdateLicense` (`.cmd/.sh`) | A command file (Windows) or a shell script (Linux) that updates the current `license.bea` file with new license sections. The result is a merged license that contains both the existing and new license sections. For details about using the `UpdateLicense` utility, see Updating Your WebLogic Real Time Product License.

#### Creating Multiple BEA Home Directories

Although it is possible to create more than one BEA Home directory, we recommend that you avoid doing so. In almost all situations, a single BEA Home directory is sufficient. There may be circumstances, however, in which you prefer to maintain separate development and production environments, with a separate product stack for each. With two directories, you can update your development environment (in a BEA Home directory) without modifying the production environment until you are ready to do so.

### Choosing a Product Installation Directory

The product installation directory contains all the software components that you choose to install on your system, including program files and examples. You are prompted during your initial installation to choose a product installation directory. If you accept the default on a Windows system, for example, your software is installed in the following directory:

    C:\bea\realtime10

Here, `C:\bea` is the BEA Home directory and `realtime10` is the product installation directory for the WebLogic Real Time 1.0 software. However, you can specify any name and location on your system for your product installation directory; there is no requirement that you name the directory realtime10 or create it under the BEA Home directory.

The installation program installs the software components in a product installation directory represented by the `WLRT_HOME` variable. If, during your initial installation, you choose to install WebLogic Server only, and not all of the products available for installation, and you later decide to install additional products, such as AquaLogic Service Bus (using the same BEA Home directory), you are not prompted, during the subsequent installations, to specify a product installation directory. The installation program detects the `WLRT_HOME` directory and installs the additional products under it.

A description of the WebLogic Real Time directory structure is provided in Understanding the Product Directory Structure.

## Choosing the Type of Installation

The BEA Products installation program provides two types of installation: Complete and Custom.

### Complete Installation

In a complete installation, the following software is installed:

- WebLogic Server program files and related sample files
- Apache Beehive program files
- Sample domains, preconfigured for use with the PointBase database, which allow you to start running the samples as soon as the installation is complete.
- BEA JRockit 5.0 JDK with Deterministic GC. For more information, see WebLogic Real Time.

The following are not installed during a complete installation:

- Web Server plug-ins
- WebLogic Server Node Manager as a Windows service

### Custom Installation

In a custom installation, you have the following options:

- You can choose which software components to install on your system. For a description of the software components provided with your product distribution, see Installable Product Components. Sample domains preconfigured to use the PointBase database are created only for the installed components.

Note: | You must choose Custom installation to install the Web Server Plug-ins.

- You can choose whether to install the WebLogic Server Node Manager as a Windows Service. See About Installing Node Manager as a Windows Service.

## About Installing Node Manager as a Windows Service

When installing your software on a Windows platform, you can optionally install WebLogic Server Node Manager as a Windows service. The WebLogic Server Node Manager is used to:

- Start and stop server instances—both Administration Servers and Managed Servers—remotely.
- Monitor the self-reported health of servers and automatically kill server instances whose health state is "failed."
- Migrate servers in a WebLogic Server cluster.
- Automatically restart servers that have the "failed" health state, or have shut down unexpectedly due to a system crash or reboot.

In a multi-machine environment, you must install Node Manager on each machine that hosts Managed Server and Administration Server instances of WebLogic Server.

Note: | You must have Administrator privileges to install Node Manager as a Windows service.

In a custom installation, you can optionally install Node Manager as a Windows service. If you select Yes, Node Manager is installed as a Windows service to Listen Port 5556. To avoid port contention, you can specify an alternate Listen Port if desired. If the Listen Port number you specify is currently being used by a running application, the installation program prompts you to enter a different Node Manager Listen Port number. At the completion of the installation process, Node Manager is started using the port specified.

Note: | You are prompted to install Node Manager as a Windows service only during an initial installation. If you install additional product components during a subsequent installation, you are not prompted to install Node Manager as a Windows service.

To install Node Manager as a Windows service in silent mode, you need to specify the appropriate values in the `silent.xml` file. For more information, see Creating a silent.xml File for Silent-Mode Installation.

You can also install and uninstall Node Manager as a Windows service using the following scripts that are provided when you install WebLogic Server:

- `WLRT_HOME``\server\bin\installNodeMgrSvc.cmd`
- `WLRT_HOME``\server\bin\uninstallNodeMgrSvc.cmd`

In these pathnames, `WLRT_HOME` is the product installation directory in which you installed WebLogic Server, typically `C:\bea\realtime10`.

### Additional Considerations for Node Manager Installation

- When you install Node Manager as a Windows service, it is registered with the product installation directory in which you are installing the software, for example, `C:\bea\realtime10`. Node Manager can be used to manage communication with all domains associated with that installation directory.

If you install additional instances of WebLogic Real Time 1.0 on a machine, in different BEA Home directories, you can install a Node Manager instance as a Windows service for each installation. Each Node Manager instance will manage the domains associated with the relevant installation.

- When you install Node Manager as a Windows service during the installation process, the Node Manager listen port is specified in the BEA registry file, `registry.xml`, located in the BEA Home directory associated with the installation, typically `c:\bea`.

Note: | Do not edit this file manually. Doing so may cause operating problems for the currently installed BEA products, or result in installation problems when future BEA products or maintenance upgrades are installed. Changing the Node Manager listen port value in the `registry.xml` does not change the port for the installed service.

- When you uninstall WebLogic Server, the Node Manager service registered with the product installation directory from which you are uninstalling the product is uninstalled also. For more information about the product installation directory, see Choosing a Product Installation Directory.

For more information about Node Manager, including instructions for installing it on a Linux system, see "Using Node Manager to Control Servers" in Managing Server Startup and Shutdown at `http://download.oracle.com/docs/cd/E13222_01/wls/docs91/server_start/nodemgr.html`.

## Generating a Verbose Installation Log

If you launch the installation from the command line or from a script, you can specify the `-log` option to generate a verbose installation log. The installation log stores messages about events that occur during the installation process, including informational, warning, error, and fatal messages. This type of file can be especially useful for silent installations.

Note: | You may see some warning messages in the installation log. However, unless a fatal error occurs, the installation program completes the installation successfully. The installation user interface indicates the success or failure of each installation attempt, and the installation log file includes an entry indicating that the installation was successful.

### Syntax

To create a verbose log file during installation, include the `-log=``full_path_to_log_file` option in the command line. For example:

    server910_win32.exe -log=C:\logs\server_install.log

The path must specify a file. You cannot create a folder simply by including a name for it in a pathname; your path should specify only existing folders. If your path includes a nonexistent folder when you execute the command, the installation program does not create the log file.

Note: |