# Installation Guide

# Installing Oracle Communications Services Gatekeeper

This chapter describes how to use the Oracle Communications Services Gatekeeper installers. This process must be followed on every server in the system. The chapter includes information on:

- The Graphical Mode Installer
- The Console Installer
- The Silent Mode Installer
- Where to Go From Here

Before you run the installer, you should have a high level understanding of the entire installation and configuration process. See Task Overview for more information.

## The Graphical Mode Installer

Use the following instructions if you wish to use the GUI-based installer to install Oracle Communications Services Gatekeeper. You must do this for all servers.

Note: | If you want to use the GUI-based installer, 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 UNIX/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.

### Launch the GUI Installer - Windows

Note: | Windows is only supported for dev/test environments. It is not supported for production.

If you are using the GUI-based installer on a Windows machine, do the following:

1. Log in to the Windows system. If you are going to use this machine as an Administration Server and you wish to install the Node Manager as a Windows service, you must be logged in as an administrator. Node Manager is used to monitor, start, and stop server instances in a domain.
2. Go to the directory where you have copied the installation program. You acquire this program either from an Oracle Communications Services Gatekeeper CD or the eDelivery Center.
3. If you are using Explorer to find the file, double-click the installation file, `_win_x86.exe`
4. If you are using the console window to find the file, enter the following command:

    ocsg411_win_x86

You can also include the `-log=full_path_to_log_file` option in the command line to create a verbose installation log. For example:

    ocsg411_win_x86 -log=<full_path>install.log

5. Go on to Respond to the Prompts

### Launch the GUI Installer - UNIX/Linux

If you are using the GUI-based installer on a UNIX/Linux machine, do the following:

1. Log into the target UNIX system
2. Go to the directory where you have copied the installation program. You acquire this program either from the Oracle Communications Services Gatekeeper CD or the eDelivery Center.
3. Launch the installation by entering the following two commands:

`chmod a+x ocsg411_<appropriate-platform-filename>.bin`

`./ocsg411_<appropriate-platform-filename>.bin`

You can also include the `-log=full_path_to_log_file` option in the command line to create a verbose installation log. For example:

    ocsg411_<appropriate-platform-filename>.bin -log=<full_path>install.log

Note: | For Linux Redhat AS4, use `ocsg411_linux_x86.bin` for x86 installations`` and `ocsg411_linux_x86_64.bin` for x86-64 installations. For Solaris 9 or 10, use `ocsg411_solaris_sparc.bin` for 32 bit installations and `ocsg411_solaris_sparc_64.bin` for 64 bit installations.

4. Go on to Respond to the Prompts

### Launch the GUI Installer - Generic

Oracle Communications Services Gatekeeper ships with a generic installer that is primarily designed to be run on machines running HP-UX. If you are using the GUI-based installer, do the following:

1. Log into the target UNIX system
2. Add the `bin` directory of the appropriate JDK (installed separately) to the beginning of the `PATH` variable definition on the target system. For example:

    PATH=JAVA_HOME/bin:$PATH

    export PATH

Here `JAVA_HOME` represents the full path to the JDK directory.

3. Go to the directory where you downloaded the installation program.
4. Launch the installation program by entering the following command:

    java -jar ./ocsg411_generic.jar

5. Go on to Respond to the Prompts

Note: | Once you have run the installer you must do the following additional two steps:

1. Set the `WL_HOME` variable to the directory in which you installed your Oracle Communications product, and export `WL_HOME`. For example:

    $ export WL_HOME=<your_installation_directory>/wlserver_10.3

    cd $WL_HOME/server/native/hpux11/IPF32/

2. Set the following execution modes on the contents of the `$WL_HOME/server/native` directory:

    $ chmod -R +x $WL_HOME/server/native/hpux11/

### Respond to the Prompts

The installation program prompts you to enter specific information about your system and configuration. For instructions on responding to the prompts during installation, see the following table.

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 Exit.
Choose BEA Home Directory | Specify the BEA Home directory that will serve as the central support directory for all BEA products installed on the target system. If you already have a BEA Home directory on your system, you can select that directory (recommended) or create a new BEA Home directory. If you choose to create a new directory by typing a new directory name in the BEA Home Directory field, the installation program automatically creates one for you. You can also click Browse and select a directory from the BEA Home Directory Selection window.
Choose Install Type | Select the type of installation you wish to perform: Typical - Installs WebLogic Server, Oracle Communications Services Gatekeeper (including the Platform Development Studio), and Converged Application Server Custom - Allows you to choose to install individual components
Note: | This window may not appear if you have other Oracle/BEA products installed on this machine.
Choose Products and Components This window only appears if you have selected the Custom installation type | Uncheck any component you do not wish to install
Note: | You cannot install the Platform Development Studio without Oracle WebLogic Server and Oracle Communications Services Gatekeeper.
JDK Selection This window only appears if you have selected the Custom installation type | Select the JDK you wish to have installed for use with Oracle Communications Services Gatekeeper.
Platform Development Studio Eclipse Plugin Path This window only appears if you have chosen to install the PDS | In the text box, enter the full path to the Plugin directory of your Eclipse installation. You can also use the Browse button to locate the directory.
Choose Product Installation Directories | Specify the directories in which you want to install the Oracle Communications Services Gatekeeper, WebLogic Server, and Converged Application software. These are the directories from which information will be copied during the domain configuration phase. Once you have chosen your directories, click Next. You can accept the default product directories or create a new product directory.
Install Windows Service This window only appears if you are installing the software on a Windows machine and you’ve chosen a Custom installation type | The Node Manager allows you to stop and start Managed Servers remotely. If you are installing on a Windows machine, the Node Manager should be installed as a Windows Service. Select Yes to install or No to skip installation
Choose Shortcut Location This window is displayed only under the following conditions: You have Administrator privileges. You are performing an initial installation. You are installing on a Windows platform. | Specify the Start menu folder in which you want the Start menu shortcuts created. You can select from the following options: All Users Start menu folder Selecting this option provides all users registered on the machine with access to the installed software. However, only users with Administrator privileges can create shortcuts in the All Users folder. Therefore, if a user without Administrator privileges uses the Configuration Wizard 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. Press ALT+Y on the keyboard to select the All Users Start Menu. Local user's Start menu folder Selecting this option ensures that other users registered on this machine will not have access to the Start menu entries for this installation. Press ALT+N on the keyboard to select the Local User's start menu.
Installation Summary | Check to make sure this is the list of all the products and JDKs you have chosen to install.
Status | A progress bar indicates the status of the installation process. When the installation program has finished copying the specified files to your system, click Next.
Installation Complete | If you are using Windows, specify whether you want to run the QuickStart application. QuickStart, designed to assist first-time users in evaluating, learning, and using the software, provides quick access to domain configuration wizard. Clear the check box for this option if you do not want to launch QuickStart.

## The Console Installer

Use the following instructions if you wish to use the Console-based installer to install Oracle Communications Services Gatekeeper. You must do this for all servers.

### Launch the Console Installer - Windows

Note: | Windows is only supported for dev/test environments. It is not supported for production.

If you are using the Console-based installer on a Windows machine, do the following:

1. Log in to the target Windows system.
2. Go to the directory where you have copied the installation program. You acquire this program either from a Oracle Communications Services Gatekeeper CD or the eDelivery Center.
3. Launch the installation by entering the following command:

`ocsg411_win_x86.exe -mode=console`

You can also include the `-log=full_path_to_log_file` option in the command line to ocsg411`_win_x86.exe -mode=console -log=C:\logs\server_install.log`

4. After a few moments, an Installer window opens and the installation program begins to install the software.
5. Go on to Respond to the Prompts

### Launch the Console Installer - UNIX/Linux

If you are using the Console-based installer on a UNIX/Linux machine, do the following:

1. Log into the target UNIX system
2. Go to the directory where you have copied the installation program. You acquire this program either from the Oracle Communications Services Gatekeeper CD or the eDelivery Center.
3. Launch the installation by entering the following two commands:

`chmod a+x ocsg411_<appropriate-platform-filename>.bin`

`./ocsg411_<appropriate-platform-filename>.bin -mode=console`

You can also include the `-log=full_path_to_log_file` option in the command line to create a verbose installation log. For example:

`./ocsg411_<appropriate-platform-filename>.bin -mode=console -log=/home/logs/server_install.log [all on one line]`

Note: | For Linux Redhat AS4, use `ocsg411_linux_x86.bin` for x86 installations`` and `ocsg411_linux_x86_64.bin` for x86-64 installations. For Solaris 9 or 10, use `ocsg411_solaris_sparc.bin` for 32 bit installations and `ocsg411_solaris_sparc_64.bin` for 64 bit installations.

4. After a few moments, an Installer window opens the installation program begins to install the software.
5. Go on to Respond to the Prompts

### Launch the Console Installer - Generic

Oracle Communications Services Gatekeeper ships with a generic installer that is primarily designed to be run on machines running HP-UX. If you are using the console based installer, do the following:

1. Log into the target UNIX system
2. Add the `bin` directory of the appropriate JDK (installed separately) to the beginning of the `PATH` variable definition on the target system. For example:

    PATH=JAVA_HOME/bin:$PATH

    export PATH

Here `JAVA_HOME` represents the full path to the JDK directory.

3. Go to the directory where you downloaded the installation program.
4. Launch the installation program by entering the following command:

    java -jar ./wlng400_generic.jar -mode=console

5. Go on to Respond to the Prompts

Note: | Once you have run the installer you must do the following two additional steps:

1. Set the `WL_HOME` variable to the directory in which you installed your Oracle Communications product, and export `WL_HOME`. For example:

    $ export WL_HOME=<your_installation_directory>/wlserver_10.3

    cd $WL_HOME/server/native/hpux11/IPF32/

2. Set the following execution modes on the contents of the `$WL_HOME/server/native` directory:

    $ chmod -R +x $WL_HOME/server/native/hpux11/

### Respond to the Prompts

The installation program prompts you to enter specific information about your system and configuration. For instructions on responding to the prompts during installation, see the following table.

To complete the console-mode installation process, respond to the prompts in each section by entering the number associated with your choice or by pressing Enter to accept the default. To exit the installation process, enter exit (or x, for short) in response to any prompt. To review or change your selection, enter previous (or p, for short) at the prompt. To proceed to the following window, enter next (or n, for short).

Note: | In the sample console text and directory pathnames provided in this section, Windows conventions (such as backslashes in pathnames) are used, for example, C:\bea\weblogic. When entering pathnames on a UNIX system, be sure to use UNIX conventions, instead. For example, use forward slashes in pathnames, such as /home/bea/weblogic.

On this screen... | Perform the following action...
--- | ---
Welcome | Type next (or n for short) or press Enter to continue with the installation
Choose BEA Home Directory | Specify the BEA Home directory that will serve as the central support directory for all BEA products installed on the target system. If you already have a BEA Home directory on your system, you can select that directory or create a new BEA Home directory. If you already have an existing BEA Home directory, it will be displayed. To use that directory, type the number associated with it. To create a new BEA Home directory, type 1 or press Enter. If there are no BEA Home directories on your system, or you have selected to create a new BEA Home: To choose the default directory, simply type n or Enter. To select a new directory, enter its full path: for example: `C:\beahome` The installer asks you to confirm your choice:. To accept your choice, type Enter To go back, type `1` or `2`, as you desire
Choose Install Type | Select the type of installation you wish to perform: 1 - Typical - Installs WebLogic Server, Oracle Communications Services Gatekeeper (including the Platform Development Studio), and Converged Application Server 2 - Custom - Allows you to choose to install individual components
Choose Components This window only appears if you have selected the Custom installation type | Enter the number next to the name(s) of the component(s) you do not wish to install and hit Enter. The screen refreshes, and the checkmark next to that component is removed. Continue until only the items you wish to install are checkmarked.
Note: | You cannot install the Platform Development Studio without WebLogic Server and Oracle Communications Services Gatekeeper.
Hit n to continue.
JDK Selection This window only appears if you have selected the Custom installation type | Select the number of the JDK you wish to have installed for use with Oracle Communications Services Gatekeeper or use 1 to add the path to your own JDK.
Platform Development Studio Eclipse Plugin Path This window only appears if you have chosen to install the PDS | Enter 1 to enter the path to your `Eclipse\plugins` directory. Then enter the full path. The screen refreshes, and the path is displayed. Hit n to continue.
Choose Product Directory | Specify the directories in which you want to install the Oracle Communications Services Gatekeeper software. These are the directories from which information will be copied during the domain configuration phase. You can accept the default product directories or create a one or more new directories by selecting the product index number and then inputting the full path to that directory. The installer asks you to confirm your choice.
Choose Shortcut Location This window is displayed only under the following conditions: You have Administrator privileges. You are performing an initial installation. You are installing on a Windows platform. | Specify the Start menu folder in which you want the Start menu shortcuts created. You can select from the following options: All Users Start menu folder Selecting this option provides all users registered on the machine with access to the installed software. However, only users with Administrator privileges can create shortcuts in the All Users folder. Therefore, if a user without Administrator privileges uses the Configuration Wizard 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. Press ALT+Y on the keyboard to select the All Users Start Menu. Local user's Start menu folder Selecting this option ensures that other users registered on this machine will not have access to the Start menu entries for this installation. Press ALT+N on the keyboard to select the Local User's start menu. The installer asks you to confirm your choice.
Installation Summary | Check to make sure this is the list of all the products and JDKs you have chosen to install.
Status | Status bars indicates the progress of the installation.
Installation Complete | Press Enter to exit the installer.

## The Silent Mode Installer

Silent-mode installation is a way of choosing installation settings only once and then using those settings to duplicate the installation on many machines. During installation in silent mode, the installation program reads your settings from an XML file that you create prior to beginning the installation. The installation program does not display any options during the installation process. Silent-mode installation works on both Windows and Linux/UNIX systems. Please note: Windows is only supported for dev/test environments. It is not supported for production.

Note: | For more information on Silent-mode installation, see Oracle WebLogic Server Installation Guide at http://download.oracle.com/docs/cd/E12840_01/common/docs103/install/index.html, which gives a description of silent mode installation for WebLogic Server in general.

Use the following instructions if you wish to use the Silent Mode installer to install Oracle Communications Services Gatekeeper. You must do this for all servers.

### Create the silent.xml file

The entries in the silent.xml file correspond to the prompts that you would see if you used one of the interactive modes above.

Note: | Incorrect entries in the silent.xml file can cause installation failures. To help you determine the cause of a failure, we recommend that you create a log file when you start the installation.

The following is a sample version of a silent.xml file, corresponding to a Complete installation type. Your input may be slightly different, depending on your installation:

Note: | This sample calls out explicitly what is to be installed. If you use a more generic version, you may encounter an error similar to this in the log.

    com.bea.plateng.domain.script.ScriptException: The template to read must be a jar file containing a valid domain configuration

Note: | This error can be ignored.See the Oracle WebLogic Server Installation Guide for more information.

Listing 6-1 Sample silent.xml

    <?xml version="1.0" encoding="UTF-8" ?>

    <bea-installer>

      <input-fields>

        <data-value name="BEAHOME" value="/var/nightly/bea" />

        <data-value name="COMPONENT_PATHS" value="Oracle Communications Services Gatekeeper|WebLogic Communications Server|WebLogic Server/Core Application Server| WebLogic  Server/Third Party JDBC Drivers|WebLogic Server/Web 2.0 HTTP Pub-Sub Server|WebLogic Server/WebLogic JDBC Drivers|WebLogic Server/WebLogic Web Server Plugins|WebLogicServer/Administration Console|WebLogic Server/Configuration Wizard and Upgrade Framework"/>

        <data-value name="INSTALL_NODE_MANAGER_SERVICE" value="no" />

        <data-value name="WLNGEclipseConfig.dir" value="/var/nightly/bea"/>

      </input-fields>

    </bea-installer>

### Launch the Silent Installer - Windows

If you are using the silent installer on a Windows machine, do the following:

1. Log in to the target Windows system. If you are going to use this machine as an Administration Server and you wish to install the Node Manager as a Windows service, you must be logged in as an administrator. Node Manager is used to monitor, start, and stop managed server instances in a domain.
2. Go to the directory where you have copied the installation program. You acquire this program either from an Oracle Communications Services Gatekeeper CD or the eDelivery site.
3. Launch the installation by entering the following command:

`ocsg411_win_x86.exe -mode=silent -log=<full_path_name>install.log -silent_xml=<full_path_name>silent_xml [all on one line]`

4. After a few moments, an Oracle Installer window opens, indicating that the files are being extracted. No other prompt or text is displayed.

### Launch the Silent Installer - UNIX/Linux

If you are using the silent installer on a UNIX/Linux machine, do the following:

1. Log into the target UNIX system
2. Go to the directory where you have copied the installation program. You acquire this program either from an Oracle Communications Services Gatekeeper CD or the eDelivery site..
3. Launch the installation by entering the following commands:

`chmod a+x ocsg411_<appropriate-platform-filename>.bin`

`./<filename.bin> -mode=silent -log=<full_path_name>install.log -silent.xml=<full_path_name>silent.xml [all on one line]`

4. After a few moments, an Oracle Installer window opens, indicating that the files are being extracted. No other prompt or text is displayed.

Note: | For Linux Redhat AS4, use `ocsg411_linux_x86.bin` for x86 installations`` and `ocsg411_linux_x86_64.bin` for x86-64 installations. For Solaris 9 or 10, use `ocsg411_solaris_sparc.bin` for 32 bit installations and `ocsg411_solaris_sparc_64.bin` for 64 bit installations.

### Launch the Silent Installer - Generic

Oracle Communications Services Gatekeeper ships with a generic installer that is primarily designed to be run on machines running HP-UX:

1. Log into the target UNIX system
2. Add the `bin` directory of the appropriate JDK to the beginning of the `PATH` variable definition on the target system. For example:

    PATH=JAVA_HOME/bin:$PATH

    export PATH

Here `JAVA_HOME` represents the full path to the JDK directory.

3. Go to the directory where you downloaded the installation program.
4. Launch the installation program by entering the following command:

    java -jar ./ocsg411_generic.jar -mode=silent -silent_xml=/full_path_to_silent.xml [all on one line]

Note: | Once you have run the installer you must do the following additional two steps:

1. Set the `WL_HOME` variable to the directory in which you installed your Oracle product, and export `WL_HOME`. For example:

    $ export WL_HOME=<your_installation_directory>/wlserver_10.3

    cd $WL_HOME/server/native/hpux11/IPF32/

2. Set the following execution modes on the contents of the `$WL_HOME/server/native` directory:

    $ chmod -R +x $WL_HOME/server/native/hpux11/

### Returning Exit Codes to the Console

When run in silent mode, the installation program generates exit codes that indicate the success or failure of the installation. These exit codes are shown in the following table:

Table 6-1 Installation Program Exit Codes
Code | Description
--- | ---
0 | Installation completed successfully
-1 | Installation failed due to a fatal error
-2 | Installation failed due to an internal XML parsing error

If you are launching the silent-mode installation process from a script, you can choose to have these exit codes displayed to the console. The following provides a sample command file that invokes the WebLogic Platform installation in silent mode and echoes the exit codes to the console from which the script is executed.

Listing 6-2 Return exit codes

    rem Execute the installer in silent mode

    @echo off

    ocsg411_win_x86.exe -mode=silent -log=<full_path_name>install.log -silent_xml=<full_path_name>silent.xml

    @rem Return an exit code to indicate success or failure of installation

    set exit_code=%ERRORLEVEL%

    @echo.

    @echo Exitcode=%exit_code%

    @echo.

    @echo Exit Code Key

    @echo ---------------

    @echo  0=Installation completed successfully

    @echo -1=Installation failed due to a fatal error

    @echo -2=Installation failed due to an internal XML parsing error

    @echo.

## Where to Go From Here

You must now configure Oracle Communications Services Gatekeeper’s Administrative Domain. See Configuring the Domain for Oracle Communications Services Gatekeeper

Note: | If you wish to be able to start and stop servers remotely, for example by using the Administration Console, you must set up Node Manager on each server. The software for Node Manager is automatically installed along with WebLogic Server software when you use any of the installation methods. See Oracle WebLogic Server Managing Server Startup and Shutdown, at http://download.oracle.com/docs/cd/E12840_01/wls/docs103/server_start/ for more information on setting up and configuring Node Manager.