Skip Headers

Oracle® Communication and Mobility Server Installation Guide 10g Release 3 (10.1.3) Part Number E12657-02 |
Home | Contents | Index | Contact Us

Previous | Next
| View PDF

# 2 Install Oracle Communication and Mobility Server

This chapter describes how to perform an installation of Oracle Communication and Mobility Server (OCMS). It contains the following sections:

- Install a Cluster of OCMS Instances in a High Availability Environment

- Install Oracle Communication and Mobility Server

- Start and Stop Oracle Communication and Mobility Server

- Start and Stop Edge Proxy

- Deinstall

- Troubleshoot Installation Issues

## Install a Cluster of OCMS Instances in a High Availability Environment

You can install OCMS either as a single node for evaluation or development, or you can install OCMS to multiple nodes for a high availability production topology. For a high availability production topology you will need one or more Edge Proxies nodes along with the other OCMS nodes. Edge Proxies provide scalability and high availability. Edge Proxies are required for advanced production level topologies, and are usually used to provide SIP distribution. The Edge Proxy distributes incoming SIP traffic among OCMS SIP application servers when used between a SIP unaware load balancer and an OCMS cluster.

For information on recommended deployment topologies and configuring high availability see the "Deployment Topologies" and "Configuring High Availability" chapters in the Oracle Communication and Mobility Server Administrator's Guide.

### Configure OCMS in a Clustered Environment with Edge Proxies

An administrator typically installs Edge Proxies on separate nodes. The installation of an Edge Proxy as part of an OCMS installation is supported only in Oracle Application Server installation mode. An Edge Proxy is aware of multiple OCMS instances through OPMN clustering. This requires a clustered Oracle Application Server 10.1.3.4 environment where each OCMS instance references a unique Oracle Home.

### Size the Installation

The number of Edge Proxies recommended for an OCMS installation depends on scalability and high availability requirements for the installation and on the number of SIP clients and OCMS instances. A minimum of two Edge Proxies is recommended to guarantee high availability in a clustered environment. As the number of SIP clients or OCMS instances grows, additional Edge Proxy servers can be added. Refer to the Oracle Communication and Mobility Server Administrator's Guide for more information.

In OCMS installations with three or more OCMS instances, Edge Proxies are typically separately installed OCMS instances that consists of only the Edge Proxy application (that is, only Edge Proxy per OCMS instance is selected for installation). For OCMS installations with not more than two instances, Edge Proxies can be installed concurrently with the OCMS instances.

### Assign Ports in a Multi-Instance Installation

After you have decided on the number of OCMS instances and Edge Proxy-only instances in the OCMS installation, you must decide what ports will be assigned to each instance. For single machine installations, each instance in the OCMS installation must have uniquely defined ports. The OCMS installer verifies that ports are available at the time of installation. Example 2-1 shows how to assign ports in a multi-instance OCMS installation with an Edge Proxy server.

Example 2-1 Assigning Ports in a Multi-Instance OCMS Installation with an Edge Proxy

    OCMS instance 1: Custom installation consisting of Edge Proxy only
    Edge Proxy Port: 5060 (default)

    OCMS instance 2: Typical installation
    SIP Port: 5080 (user-configured during installation)

    OCMS instance 3: Typical installation
    SIP Port: 5090 (user-configured during installation)

    OCMS instance 4: Typical installation
    SIP Port: 5100 (user-configured during installation)

### Install Edge Proxies

Perform the following steps to install Edge Proxies into an OCMS installation:

1. In the Available Product Components screen of Oracle Universal Installer, select the Edge Proxy component.

   Note:

   No other component should be selected, only the Edge Proxy.

2. Click Next.

3. Complete the OCMS installation.

4. Perform an opmnctl status command to see the status of the Edge Proxy.

   The Edge Proxy runs automatically after being installed and reports a status of "Alive."

5. Run the Oracle Universal Installer and repeat the steps above to configure additional Edge Proxies.

6. Perform the following additional procedures in the Oracle Communication and Mobility Server Administrator's Guide:

   - "Configuring the OCMS SIP Containers for High Availability"

   - "Configuring the Edge Proxy Nodes for High Availability"

   - "Configuring Highly Available SIP Servlet Applications"

7. Install the non-Edge Proxy OCMS instances using the procedures in this guide.

   After installation of all the Edge Proxies and OCMS instances you will be able to view the topology of the OCMS installation through Enterprise Manager from the Oracle Application Server instance where "Start AS Control" was selected during Oracle Application Server installation.

## Install Oracle Communication and Mobility Server

You can install OCMS on the Microsoft Windows or Linux operating systems.

Perform the following steps to install OCMS:

1. Close any SIP client applications that are running.

2. Run the installation executable for your operating system:

   - For Microsoft Windows operating systems, run setup.exe.

   - For Linux operating systems, run runInstaller.

   Oracle Universal Installer starts and automatically installs Java 2 Platform, Standard Edition Development Kit (JDK) 1.5.0.0.6.

   The Welcome screen appears.

   Figure 2-1 Welcome screen

   Description of "Figure 2-1 Welcome screen"

   Note:

   Each screen in Oracle Universal Installer contains a Help button. Use the Help to get more information about the screen.

3. Click Next to continue. The Specify File Locations screen is displayed.

4. Ideally, you should not modify the stage location. When installing into an existing Oracle Application Server installation, ensure that you select the existing ORACLE_HOME as the installation location. Do not leave any fields blank. Click Next to continue.

### Select an Installation Type

This screen enables you to select the Installation Type.

1. Select the Installation Type you want t perform:

   - Install in standalone developer mode: The standalone developer mode is recommended for development users only due to limited management capabilities. This option installs Oracle Containers for J2EE (OC4J) software, Release 10.1.3.4, and does not require an application server.

   - Install to existing Oracle Application Server (release 10.1.3.4 is supported): This installation mode is the recommended selection for production deployments. Oracle Universal Installer verifies if the provided Application Server Home contains an Oracle Application Server installation.

     Note:

     When installing into an existing Oracle Application Server, Oracle Universal Installer automatically names the OC4J instance ocms. Before installing OCMS, ensure that you do not have any other instances of OC4J named ocms in your ORACLE_HOME.

2. Click Next to continue. The Available Product Components screen is displayed.

### Specify the Primary Server Address

The Primary Server Address is the address that clients will use to communicate with OCMS.

Figure 2-2 Primary Server Address screen

Description of "Figure 2-2 Primary Server Address screen"

1. Select the primary server listening address from the drop-down menu.

2. Click Next to proceed. The OC4J Admin and Password screen appears.

### Specify the OC4J Admin and Password

If installing in standalone mode, the password provides for validation in stopping the OCMS instance.

If installing in Oracle Application Server mode, entering the administrator password allows for immediate validation of these credentials by the Oracle Application server.

Figure 2-3 OC4J Admin screen

Description of "Figure 2-3 OC4J Admin screen"

1. Enter the Administrator username.

2. Enter the Administrator password.

3. Click Next to proceed. The Oracle DB Details screen appears.

Note:

After these initial screens, the order of presentation of screens for the installation will vary depending upon on your product/component selections. The following screens are presented in a certain order, but that presentation is not meant to imply that your installation will proceed in the same order.

### Provide Oracle DB Details

Use this screen to enter the details about your Oracle database.

Figure 2-4

Description of "Figure 2-4 "

1. Fill-in the following fields (your database credentials will be validated when you connect to the database):

   - SYS Password

   - Hostname

   - Port

   - SID

   - Schema Prefix

   - Schema Password (and confirmation of same)

   - Service Name

2. Click Next to proceed.

### SDP Datafile Directory

Use this screen to specify whether or not you want to specify the SDP Datafile directory.

Figure 2-5 SDP Datafile Directory screen

Description of "Figure 2-5 SDP Datafile Directory screen"

- If you choose to specify the directory, the next screen (SDP Datafile Location) enables you to input that information.

  Note:

  You must ensure that the database data file directory is present and writable. If it is not, then the configuration tool will fail.

- If you do not want to specify a location, the default DB datafile directory will be used.

Click Next to proceed.

### DB Schema

Select Yes or No to reuse the existing schema, then click Next to proceed. The STUN Server Configuration screen appears, if you chose to install a STUN Server earlier.

Figure 2-6 DB Schema screen

Description of "Figure 2-6 DB Schema screen"

### Specify the STUN Server Configuration

If you selected STUN Server for installation, you will be prompted to enter the host and port for the primary and secondary STUN servers. Configuring both primary and secondary STUN servers is required.

To specify the STUN Server hosts and ports:

1. Enter the hostname or IP address of the primary STUN server in the Primary Host Address field.

2. Enter the Primary Port.

3. Enter the hostname or IP address of the secondary STUN server in the Secondary Host Address field.

4. Enter the Secondary Port.

5. Click Next to continue.

### Configure Test Users

When installing OCMS you can create a number of predefined test users. To create test users, click Yes, then OK to proceed. The Test User Details screen appears.

Figure 2-7 Test Users screen

Description of "Figure 2-7 Test Users screen"

### Test User Details

Use this screen to enter details about test users.

Figure 2-8 Test Users Details screen

Description of "Figure 2-8 Test Users Details screen"

1. Select the Number of Test Users from 1-12.

2. Enter the Username Prefix for the test users.

   The default prefix is "test.user". The username for each test user will be prefixed by this string.

   For example, if you select 3 for Number of Test Users and "test.user" for Username Prefix, the following test users will be created:

   `test.user1@sip-domain test.user2@sip-domain test.user3@sip-domain`

   WARNING:

   This release of OCMS supports lowercase usernames. Only use lowercase usernames for the Username Prefix.

3. Enter the Password for the test users.

   Each test user will have this password.

4. Confirm the Password for the test users.

5. Click Next.

### Configure the SIP Container

Provide the following SIP Container information:

Figure 2-9 Configure SIP screen

Description of "Figure 2-9 Configure SIP screen"

- SIP Port: The default SIP port is displayed. The port used is 5070 in an installation with Edge Proxy, and is port 5060 in an installation without Edge Proxy.

  If you receive a message that the SIP port is in use, exit all client applications, select Back, and return to this window.

- SIP Domain: Specifies the domain or hostname of the machine where OCMS is being installed. The default is example.com.

- SIP Realm: Specifies the SIP realm used for authentication. This is also the domain or hostname of the machine where OCMS is being installed. The default is example.com.

- OC4J HTTP Port (standalone developer mode only): Specifies the HTTP port used to manage OCMS through OC4J in standalone developer mode. The default port is 8888. If another application uses this port you can select another port.

  In Oracle Application Server mode you will not have the option to set the OC4J HTTP Port as it is autodetected by the installer from your Oracle Application Server installation. For installation to an Oracle Application Server which does not have the HTTP_Server component installed, the installer will automatically pick the first free port in the range 7785 – 7799.

Note:

Oracle Universal Installer enables configuration of only one SIP domain and one SIP realm. You can configure additional SIP domains and SIP realms after the installation using the Domains and Realms attribute of the SIP Servlet Container MBean. Multiple SIP domains can exist in a SIP realm. Refer to Oracle Communication and Mobility Server Administrator's Guide for more information.

### Summary Information

The OCMS installation summary screen displays the installation environment, the components to be installed, and the settings and port numbers that you configured.

Figure 2-10 Summary screen

Description of "Figure 2-10 Summary screen"

1. Record the installation summary information in the "Installation Configuration" section, including port numbers, for your later reference.

   This information is required when configuring the SIP client.

2. Ensure that all the installation summary information is correct, and the correct OCMS applications will be installed.

3. Click Install to begin installing the OCMS components. The End of Installation screen appears when all of your selected products/components have been installed.

   Note:

   If you encountered any errors during the installation, look at the installation log file at $HOME/oraInventory/logs

4. Click Exit to exit the installation.

### List the Oracle Remote Method Invocation (RMI) Port

Oracle Application Server Containers for J2EE (OC4J) provides support for allowing EJBs to invoke one another across OC4J containers using the proprietary Remote Method Invocation (RMI)/Oracle RMI (ORMI) protocol. For more information on Oracle RMI, refer to Oracle Application Server Containers for J2EE Services Guide.

If a particular JMX application requires connecting to the Oracle RMI port, then you will need to know what port is assigned for RMI. The RMI port is dynamically assigned by OPMN (Oracle Process Management and Notification).

The following command lists the latest port assignments:

    opmnctl status -l

For example (some columns omitted for clarity):

Figure 2-11 Output from opmnctl command

Description of "Figure 2-11 Output from opmnctl command"

The ports column of the table lists the ports selected by opmn. The following example corresponds to the OCMS instance of OC4J ("OC4J: ocms"):

    jms:12603,ajp:12503,rmis:12703,sip:5060,rmi:12403

### Verify the OCMS Installation

Perform the following steps to verify that OCMS has been successfully installed and is running:

1. With the OCMS server up and running, perform the following command to make sure that the SIP container is listening for SIP traffic on port 5060 (default SIP port):

   `netstat -a | grep 5060`

   Replace "5060" with the port number you chose during installation. You should see the following output:

   `tcp 0 0 <hostname>:5060 *:* LISTEN udp 0 0 <hostname>:5060 *:*`

2. Navigate to the Oracle Enterprise Manager Web page at http://<ip_address>:<port_number>/em.

   For port number, use one of the following values:

   - Use 8888 for standalone developer mode installation.

   - Use the HTTP server port for an Oracle AS installation with an HTTP server.

   - Use 7785 for an Oracle AS installation without an HTTP server.

   - For HTTPS, use the HTTPS port for the Oracle AS installation.

3. Enter the OC4J administrator username and password.

4. Verify that Oracle Home specifies the OCMS installation directory.

5. Verify that server Status is "Up."

6. Select the Applications tab.

7. Verify that the applications you installed are deployed and are all up and running. You may notice that one or more applications are deployed as a child application of subscriberdataservices.

   For a typical installation, you should see ocmsrouteloaderear, proxyregistrar, subscriberdataservices, and presence.

8. Return to the home page and select the Administration tab.

9. Select JMX/System MBean Browser. In the left margin, expand SipContainer and click on SipServletContainer and verify the MBean property values

The verification of OCMS is complete.

## Start and Stop Oracle Communication and Mobility Server

After installation, you can start Oracle Communication and Mobility Server. You can manually start or stop OCMS as described in the following procedures.

To start OCMS in a Linux operating system, enter the following commands:

- cd $ORACLE_HOME/sdp/bin ./startocms.sh

To stop OCMS in a Linux operating system, enter the following commands:

- cd $ORACLE_HOME/sdp/bin ./stopocms.sh

To start OCMS in a Windows operating system, enter the following command:

- Run the startocms.bat file from the <ocms_directory>\sdp\bin directory.

To stop OCMS in a Windows operating system, enter the following command:

- Run the stopocms.bat file from the <ocms_directory>\sdp\bin directory.

For installation to an existing Application Server, you can also start OCMS by executing the following:

    $ORACLE_HOME/bin/opmnctl startproc process-type=ocms

To stop OCMS in an existing Application Server:

    $ORACLE_HOME/bin/opmnctl stopproc process-type=ocms

## Start and Stop Edge Proxy

You can start and stop the Edge Proxy in an existing Application Server using the following command:

    $ORACLE_HOME/bin/opmnctl startproc process-type=EdgeProxy

To stop the Edge Proxy in an existing Application Server:

    $ORACLE_HOME/bin/opmnctl stopproc process-type=ocms

## Deinstall

Deinstallation of individual products/components is not possible; you must deinstall OCMS (using Oracle Universal Installer) in order to remove products.

## Troubleshoot Installation Issues

This section contains information about solving installation-related problems that some users have encountered.

### Port Conflicts

As described in "Port Requirements" in the Product and Installation Overview chapter of this guide, OCMS requires the use of specific ports for SIP, Presence, and Edge Proxy communications.

To verify if a port is in use, following the instructions in Checking if a Port is in Use.

If there is a conflict, you can change a port number, or stop the other service that is using that port number.

### Loss of Network Connection During Installation

During the OCMS installation, an active network connection is required.

In the uncommon event that a network connection is lost during installation, the installation can fail. Examine the `installActions<data_time>.log` file (in the Oracle inventory directory) to see a log of this event.

Note:

For more information about issues with the product, see the Release Notes that accompany this documentation.