4 Installing Oracle Communications Service Broker

This chapter describes how to use the Oracle Universal Installer to install Oracle Communications Service Broker:

• Running the Installer in Graphical Installation Mode

• Running the Installer in Silent Mode

• Directory Structure After Installation

• Deinstalling Service Broker

Running the Installer in Graphical Installation Mode

To install an Administration Console or a Processing Server or Signaling Server using the Oracle Universal installer in graphical mode:

1. In a command shell, navigate to the installer directory: installation_directory/operating_system/Disk1/install

2. Enter the following command to launch the installer:

   ./runInstaller

   The Oracle Universal Installer is launched in graphical mode.

3. The installer displays a series of windows, described in Table 4-1. Follow the instructions as described in the table.

   Table 4-1 Windows in Oracle Universal Installer Graphical Mode

   In this window	Perform the following action
   Welcome	Click Next to proceed with the installation. You may cancel the installation at any time by clicking Cancel.
   Select Installation Type	Click one of the following: Admin Console to install an Administration Console Managed Server to install a Processing Server or a Signaling Server
   Specify Home Details	Specify the home directory that will serve as the central support directory for all products installed on the target system. In this documentation, the home directory is referred to as Oracle_home. See "Choosing an Oracle Home" for details about the home directory. If you already have a home directory on your system, you can select that directory (recommended) or create a new home directory. To select an existing home directory: Select the Oracle home name from the Name list. The path to the Oracle home directory is automatically entered in the Path field. To create a new home directory: Enter a name for the installation in the Name field. Enter the path to home directory in the Path field. The installer will create the directory for you. You can alternatively click Browse to select a directory from the Choose Directory dialog box. Click Next to continue.
   Product update registration page	Specify if you want to register your installation with My Oracle Support. By registering, Oracle Support notifies you immediately of any security updates that are specific to your installation. To register your installation: In the Email field, enter the email address where you wish to be notified of updates. Select the I wish to receive security updates via My Oracle Support check box. In the My Oracle Support Password field, enter the password for your Oracle support account. If you have not registered with Oracle Support, go to the My Oracle Support Web site at https://support.oracle.com/CSP/ui/flash.html and register to obtain a My Oracle Support account. To decline registration: Deselect I wish to receive security updates via My Oracle Support. For more information about the advantages of registering your installation with My Oracle Support, see Oracle Configuration Manager Installation and Administration Guide. Click Next to continue.
   JVM Installation	Specify whether to install a JDK. If you do not install a JDK, you will be prompted for the path to an existing JDK. In a production system, you should install one of the certified versions of the JDK provided by the installer. For a test and development system, you can use a different, supported JDK. Also for test and development environments, multiple Service Broker installations can share a single JDK if they reside on the same machine. See "System Requirements" for details about supported JDKs. To install a JDK: Click Yes. Click Next. The JVM Selection window opens. To use an already installed JDK: Click No. Click Next. The Please Choose The JAVA Home Directory window opens.
   JVM Selection	This window is only displayed if you selected to install a JDK. Specify which JVM to install: Click Sun JDK to install the Sun HotSpot JDK. Click Oracle Jrockit to install the Oracle JRockit JDK. Click Next to continue.
   Specify the Java Home Directory	This window is only displayed if you selected not to install a JDK. Specify the path to an existing Java installation: In the Java Home field, enter the path to the directory where the JDK is installed or click Browse to select a directory from the Choose Directory dialog box. The path should be the same as the environment variable JAVA_HOME for your Java installation. See "System Requirements" for details about supported JDKs.
   Summary	This window displays a summary of the installation, including general information about the installation type, directories, the product components to be installed, the approximate installed size of each component, and the total size of all components to be installed. Click Install.
   Install	This window is displayed while the components are being installed. Read the information about products and services while the installer is running.
   End of Installation	This window describes the outcome of the installation. Click the Exit to exit the installation program. Click Yes to confirm your choice.

   
   

When the installation is completed, the directory structure described in "Directory Structure After Installation" is created on your server.

Running the Installer in Silent Mode

You can install an Administration Console or a Processing or Signaling Server using Oracle Universal Installer in silent mode.

You can specify the necessary installation parameters, such as what to install, the home directory, and so on, in one of two ways:

• By editing the parameters in the silentInstaller.sh installer file. Typically, this is the method you will use. The file includes all the mandatory parameters and the most frequently used parameters. Default values are given.

  See "Installing in Silent Mode Without a Response File" for instructions.

• By editing the installation response file. This file includes corresponding parameters that are in the silentInstaller.sh file, plus additional parameters that you can set. The response file, along with the -silent parameter, is given as input to the runInstaller utility.

  See "Installing in Silent Mode With a Response File" for instructions.

Installing in Silent Mode Without a Response File

To install an Administration Console or a Processing or Signaling Server in silent mode without using a response file:

1. Edit the silentInstaller.sh file so that it defines your installation. The installer file is located in the directory:

   installation_directory/operating_system/Disk1/install

   Table 4-2 lists the parameters you can edit in the silentInstaller.sh file.

   Table 4-2 Parameter-value pairs in the silentInstaller.sh file

   Parameter	Description
   INSTALL_TYPE	Specifies whether you want to install an Administration Console or a Processing or Signaling Server. Do not edit this value in the response file. Mandatory Use: 1 to install an Administration Console (this is the default) 2 to install a Processing or Signaling Server Example: INSTALL_TYPE=1
   INSTALL_JVM	Specifies whether to install one of the bundled JDKs or to use an already installed JDK. Mandatory In a production system, you should install one of the certified versions of the JDK provided by the installer. For test environments, you can use an already installed, supported JDK. Also for test environments, multiple Service Broker installations can share a single JDK if they reside on the same machine. Use: 1 to install the JDK (this is the default) 0 to use an already installed JDK Example: IS_INSTALL_JVM=1
   JAVA_HOME	The path to the directory of your Java installation. Mandatory if the value of INSTALL_JVM is 0; optional otherwise The path should be the same as the environment variable JAVA_HOME for your Java installation. Example: JAVA_HOME="/usr/local/java"
   INSTALL_PATH	The path to use as your Oracle home directory Mandatory Specify the directory that will serve as the central support directory for all Oracle products installed on the target system. Example: ORACLE_HOME="/usr/local/oracle_home" The default path is ~/OHOME1
   ORA_HOME_NAME	The name of the Oracle home Mandatory If you have previously installed an Oracle product using the Oracle Universal Installer, you already have an Oracle home defined. If you want to reuse the existing Oracle home, enter its name here. When you use an existing Oracle home name, the value you specified for ORACLE_HOME is overridden with the existing Oracle home directory path. Example: ORACLE_HOME_NAME="ORACLE_HOME" The default Oracle home is OHOME1
   JVM_TYPE	Specifies which JVM to install. Mandatory if the value of INSTALL_JVM is 1; optional otherwise Use: 1 to install Sun HotSpot JDK 2 to install Oracle JRockit JDK (this is the default) Example: JVM_TYPE=1

   
   

2. In a command shell, navigate to the install directory.

3. Enter the following command to launch the installer:

   ./silentInstaller.sh

   The installation progress is output to the console.

4. When the installation is complete, press any key to exit the installation program.

   The directory structure described in "Directory Structure After Installation" is created on your server.

Installing in Silent Mode With a Response File

The installer response file includes corresponding parameters that are specified in the silentInstaller.sh file, plus additional parameters that you can specify for your installation. The installer response file is used with the runInstaller utility.

To install an Administration Console or a Processing or Signaling Server in silent mode using a response file:

1. Edit and save the appropriate installer response file. There are two installer response files. Use the one that corresponds to the component you want to install:

   • OCSB.install_type_1.rsp for an Administration Console

   • OCSB.install_type_2.rsp for a Processing or Signaling Server

   The response files are located in the installation directory for your platform:

   installation_directory/operating_system/Disk1/stage/Response/

   Table 4-3 describes the typical parameter-value pairs that you set in the installer response file. For information on additional parameters you can set in the response file, see the content of the response file.

   Table 4-3 Parameter-value pairs in the installer response files

   Parameter	Description
   ORACLE_HOME	The path to use as your Oracle home directory Mandatory Specify the directory that will serve as the central support directory for all Oracle products installed on the target system. Example: ORACLE_HOME="/usr/local/oracle_home"
   ORACLE_HOME_NAME	The name of the Oracle home Mandatory If you have previously installed an Oracle product using the Oracle Universal Installer, you already have an Oracle home defined. If you want to reuse the existing Oracle home, enter its name here. When you use an existing Oracle home name, the value you specified for ORACLE_HOME is overridden with the existing Oracle home directory path. Example: ORACLE_HOME_NAME="ORACLE_HOME"
   DECLINE_SECURITY_UPDATES	Specify whether to decline receiving automatic updates via your Oracle support account. Mandatory if you do not wish to receive automatic updates; optional otherwise. Example: DECLINE_SECURITY_UPDATES="TRUE"
   MYORACLESUPPORT_USERNAME	The e-mail address you use for your Oracle Support account. Mandatory If you have not registered with Oracle Support, go to the My Oracle Support Web site at: https://support.oracle.com/CSP/ui/flash.html and register to obtain a My Oracle Support account. By registering for updates, Oracle Support notifies you immediately of any security updates that are specific to your installation. Example: MYORACLESUPPORT_USERNAME="[e-mail]"
   MYORACLESUPPORT_PASSWORD	The password associated with your Oracle support account Mandatory unless DECLINE_SECURITY_UPDATES is set to "TRUE". Used for verification of MYORACLESUPPORT_USERNAME.
   IS_INSTALL_JVM	Specifies whether to install one of the bundled JDKs or to use an already installed, supported JDK. Mandatory In a production system, you should install one of the certified versions of the JDK provided by the installer. For test environments, you can use an already installed, supported JDK. Also for test environments, multiple Service Broker installations can share a single JDK if they reside on the same machine. Use: "TRUE" to install the JDK "FALSE" to use an already installed JDK Example: IS_INSTALL_JVM="TRUE"
   TYPE_OF_JVM	Specifies which JVM to install. Mandatory if the value of IS_INSTALL_JVM is TRUE; optional otherwise Use: 0 to install Sun HotSpot JDK 1 to install Oracle JRockit JDK Example: TYPE_OF_JVM=1
   JAVA_HOME	The path to the directory of your Java installation. Mandatory if the value of IS_INSTALL_JVM is FALSE; optional otherwise The path should be the same as the environment variable JAVA_HOME for your Java installation. Example: JAVA_HOME="/usr/local/java"

   
   

2. In a command shell, navigate to the installer directory:

   install_directory/operating_system/Disk1/install

3. Enter the following command to launch the installer:

   ./runInstaller -silent -responseFile full_path_to_response_file

   For example, to install an Administration Console on a Linux64 operating system:

   ./runInstaller -silent -responseFile installation_directory/Linux64/Disk1/stage/Response/OCSB.install_type1.rsp

   The installation progress is output to the console.

4. When the installation is complete, press any key to exit the installation program.

   The directory structure described in "Directory Structure After Installation" is created on your server.

Directory Structure After Installation

Figure 4-1 illustrates the high-level directory structure that is created during installation.

Figure 4-1 Installed Directory Hierarchy

Table 4-4 describes each directory and its contents.

Table 4-4 Installed Directories and Content Descriptions

Directory	Description
Oracle_home/axia	Base directory for your installation. Oracle_home is specified during the installation.
Oracle_home/axia/admin_console	Contains binaries for the Administration Console, and the start scripts and modules related to the Administration Console. This directory is created only if you specified to install the Administration Console during the installation.
Oracle_home/axia/managed_server	Contains binaries for the Processing Server or Signaling Server, and the start scripts and modules related to the server. This directory is created only if you specified to install a managed server during the installation.
Oracle_home/axia/jdk	Contains the Sun HotSpot JDK. This directory is created only if you specified to install the Sun JDK during the installation.
Oracle_home/axia/jrrt	Contains the Oracle JRockit JDK. This directory is created only if you specified to install the Oracle JRockit JDK during the installation.

Deinstalling Service Broker

You can deinstall Service Broker or any of its components by running the Oracle Universal Installer. When you deinstall, the installer removes all files and folders that it originally installed, but does not remove any files and folders that you created or modified, such a domain directories and configuration files.

See "Deinstalling Using Graphical Installation Mode" for instructions on deinstalling Service Broker or one of its components using Oracle Universal Installer in graphical mode.

See "Deinstalling Using Silent Mode" for instructions on deinstalling Service Broker or one of its components using Oracle Universal Installer in silent mode.

Deinstalling Using Graphical Installation Mode

To deinstall Service Broker or any of its components using the Oracle Universal Installer in graphical mode:

1. In a command shell, navigate to the installer directory: install_directory/operating_system/Disk1/install

2. Enter the following command to launch the installer:

   ./runInstaller

   The Oracle Universal Installer is launched in graphical mode.

3. In the Welcome window, click Deinstall Products.

   The Inventory window opens.

4. In the Contents tab, expand the inventory tree structure and select the components to deinstall. To deinstall all components, select the top-level directory.

   Tip:

   To save a text copy of the inventory tree and selected components before you remove components, click Save As. Navigate to a directory where you want to save the tree, enter the file name to use, and click Save.

5. Click Remove.

   The Confirmation window opens.

6. Click Yes to confirm your selection.

   The installer deinstalls the selected components.

Deinstalling Using Silent Mode

To deinstall Service Broker or one of its components in silent mode, you run the runInstaller utility from a command line.

The simplest way to specify the components to deinstall is on the command line; however, you can alternatively specify the components to deinstall in an installer response file. The installer response files are located in the installation directory for your platform:

installation_directory/operating_system/Disk1/stage/Response/

See "Installing in Silent Mode With a Response File" for more information about the installer response files.

Table 4-5 describes the parameter-value pairs that you set, either on the command line or in the installer response file.

Table 4-5 Name-value pairs for deinstalling components

Name	Description
DEINSTALL_LIST	Specify the component to deinstall. Mandatory Use the following syntax: {"component","version"} where component is one of the following: OCSB for Service Broker This deinstalls both the Administration Console and the Processing Server or Signaling Server. Falcon_AC for the Administration Console Falcon_MS for a Processing Server or Signaling Server version is the version of the component Examples: DEINSTALL_LIST={"OCSB","5.0.0.0.0"} DEINSTALL_LIST={"Falcon_AC","1.0.0.0.0"}
REMOVE_HOMES	Specify the full path to the Oracle home directory to remove. Optional Use the following syntax: {path_to_Oracle_home} Example: REMOVE_HOMES={/usr/local/oracle_home}

You can use the runInstaller utility to get a list of the installed components and their versions:

1. In a command shell, navigate to the installer directory:

   install_directory/operating_system/Disk1/install

2. Enter the following command:

   ./runInstaller -deinstall

   The installed components are listed in the output.

To deinstall Service Broker or one of its components:

1. In a command shell, navigate to the installer directory:

   install_directory/operating_system/Disk1/install

2. Enter one of the following commands to launch the installer.

   • To specify the components to deinstall on the command line, enter:

     ./runInstaller -deinstall -silent DEINSTALL_LIST={"component","version} REMOVE_HOMES={path_to_Oracle_home}

     where component, version, and path_to_Oracle_home are specified as described in Table 4-5.

   • To use an installer response file in which the components to deinstall are specified, enter:

     ./runInstaller -deinstall -silent -responseFile full_path_to_response_file

3. When deinstallation is complete, press any key to exit the installation program.