Chat now with support
Chat with Support

SharePlex 9.0 - Installation Guide

About this Guide Conventions used in this guide System Requirements SharePlex pre-installation checklist Installation and setup for Oracle cluster Installation and setup for cloud-hosted databases Download SharePlex Install SharePlex on Linux and UNIX Install SharePlex on Windows Assign SharePlex users to security groups Set up an Oracle environment for replication Set up replication between SQL Server databases Set up replication between different database types Basic SharePlex demonstrations Advanced SharePlex demonstrations Solve Installation Problems Uninstall SharePlex SharePlex Utilities Advanced installer options Install SharePlex as root Run the installer in unattended mode SharePlex installed items

Overview of SharePlex Oracle cluster support

SharePlex integrates with Oracle Clusterware cluster hardware and software to maintain the high availability of data capture and uninterrupted replication to your targets. If the node where SharePlex is running fails or must be taken out of the cluster for maintenance, SharePlex can be started on another server by the cluster software. SharePlex start and stop is controlled through the cluster.

These instructions assume that the cluster solution is already installed according to the cluster documentation, tested, and is functioning, and they are not a substitute for the documentation. Additional steps that are specific to your cluster installation may be required.

The following diagram shows SharePlex installed into an Oracle RAC cluster:


Set up SharePlex in an Oracle cluster

These instructions are for setting up SharePlex in an Oracle cluster. The setup is similar for the Windows and UNIX or Linux platforms. Differences are noted. UNIX is used in the examples.

Important! These instructions cover the parts of installing and setting up a cluster that pertain to the setup of SharePlex in the cluster. See the Oracle documentation for complete instructions for the platform that you are using.

The setup has the following phases:

Configure the cluster

Perform these steps on a source cluster and a target cluster, if applicable.

  1. On one node of the cluster, create a static application Virtual IP (VIP) address for SharePlex. This VIP must point to the node where SharePlex will run and fail over to the secondary node if the primary node fails.


    See the Oracle documentation for more information about creating a Virtual IP address on your specific platform.

    The VIP establishes a consistent host name across all nodes.

    The cluster software maps the VIP to the SharePlex server and migrates it during a failover.

    Alternatively, this mapping can be done as a host alias in the /etc/hosts file (on Unix and Linux) or the hosts file (on Windows) on both nodes. The alias is exported in the SharePlex user profile and used in the SharePlex configuration parameters.


    123.456.0.78 splex

  2. Create a tns_alias for SharePlex to use to connect to the database on each node. Use the same alias on each node of a cluster. Set load balance to off and set failover to on. For example:

    Node 1:

    	ora_a_sp =
           	(DESCRIPTION =
           	(ADDRESS_LIST =
              	(ADDRESS = (PROTOCOL = TCP)(HOST = RAC1)(PORT = 1521))
              	(ADDRESS = (PROTOCOL = TCP)(HOST = RAC2)(PORT = 1521))
            	(LOAD_BALANCE = OFF)
            	(FAILOVER = ON)
            	  (CONNECT_DATA =
            	  (SERVICE_NAME = ora_a)
    		  (INSTANCE_NAME = ora_a1)

    Node 2:

    	ora_a_sp =
           	(DESCRIPTION =
           	(ADDRESS_LIST =
              	(ADDRESS = (PROTOCOL = TCP)(HOST = RAC2)(PORT = 1521))
              	(ADDRESS = (PROTOCOL = TCP)(HOST = RAC1)(PORT = 1521))
            	(LOAD_BALANCE = OFF)
            	(FAILOVER = ON)
            	  (CONNECT_DATA =
            	  (SERVICE_NAME = ora_a)
    		  (INSTANCE_NAME = ora_a2)

    Note: A tns_alias establishes global connection information that supercedes local instance names and enables SharePlex to connect to the failover instance without requiring a configuration reactivation. SharePlex identifies the correct Oracle instance from the configuration file.

  3. (UNIX and Linux only) Add the tns_alias to the oratab file on each node that SharePlex is expected to start on during a failover.

    Example (all nodes):

  4. If the Oracle instances in the cluster have different ORACLE_HOMEs, edit the oratab file on each node and on the DNS nameserver, if applicable, to use a symbolic link in place of the actual ORACLE_HOME path:


Install SharePlex on the cluster

In a cluster, SharePlex is installed differently on Unix and Linux versus Windows.

To install on Unix and Linux

On Linux and Unix, the best practice is to install both the SharePlex variable-data and product directories on a shared drive, rather than on each node. This configuration enables more efficient failover and faster upgrades of SharePlex. If you do install these directories locally on both nodes of the cluster, do the following:

  • Install each SharePlex instance on the same port number, with identical path names. When installing on the secondary node, specify a temporary variable-data directory and then remove it after installation. Alternatively, you can use a shared drive for the variable-data directory, and then specify that directory when installing SharePlex on each node. You will configure SharePlex to use the correct variable-data directory in this procedure.
  • When prompted by the installer for the ORACLE_SID, specify the tns_alias .
  • For more information, see Install SharePlex on Linux/Unix for Oracle Database.

To install on Windows

  • On Windows, you must install the SharePlex product directory on each node of the cluster in order to make the binaries and the required MKS Toolkit components available to all nodes, and to establish Registry entries. Install each SharePlex instance on the same port number, with identical path names.

  • It is best practice to install the SharePlex variable-data directory on a shared drive to enable more efficient failover. If you do install this directory locally on both nodes of the cluster, specify a temporary variable-data directory on the secondary node and remove it after installation. You will configure SharePlex to use the correct variable-data directory in this procedure.
  • For more information, see Install SharePlex on Windows.

Run Database Setup

After you install SharePlex, run the Database Setup utility. The following applies in a cluster:

  • Source cluster: Run Database Setup and specify the tns_alias as the connection type.
  • Target system or target cluster:Run Database Setup and specify the tns_alias as the connection type, except if you are populating the target with a hot backup. If you are populating the target with a hot backup, do not run Database Setup now. You will run Database Setup during the activation procedure.
  • For more information, see Database Setup for Oracle.

Persist the SharePlex licenses

Perform these steps on a source cluster and on a target cluster, if applicable.

SharePlex will not run without a license key for each node of the cluster. This license key must be persisted in the SharePlex environment.

To add licenses on Unix and Linux

  1. On the secondary node, determine the host ID of the secondary node of the cluster by running the following command from the util subdirectory of the SharePlex product directory.


    Look for the HostID line and record the value:

    HostID = 1234567890

  2. On the primary node, run the splex_add_key utility from the install sub-directory of the SharePlex product directory.


  3. Select 3) Add license key for alternate host.
  4. Enter the machine ID of the secondary host that you recorded from the splex_uname output.
  5. Select 2) Enter license key manually.
  6. Enter the license key exactly as you received it from Quest, including the SPLEXKEY= string if one prepends the key, any spaces, and any capitalization. Press Enter when finished typing the key.
  7. Enter the customer name text string that is provided with the license key.
  8. Quit the license utility.
  9. Repeat the licensing steps for any additional secondary nodes in the cluster.

To add licenses on Windows

Run the license utility on each node of the cluster.

  1. Log on to Windows as the SharePlex Administrator.
  2. If SharePlex is running, do the following:

    1. Select the SharePlex Services tab.
    2. Select the port number of the SharePlex instance for which you want to add a license key.
    3. Click Stop.
    4. Wait for Current State to display a message that the service stopped.
  3. Select the License Keys tab.
  4. Select the SharePlex port number from the Port list.

  5. Click Add License, then type or paste the information exactly as you received it from Quest, as follows:

    1. License Key: The license key, including any spaces. The key is case-sensitive.
    2. Customer Name: The text string that was included with the license. The name is case-sensitive.
  6. (Windows Cluster) To add a license for another node in a cluster, select the Add Alternate Host Id check box, then select the machine ID from the CPU ID list box. Repeat this step to add a license to all secondary nodes in the cluster.

  7. Click OK to close the utility.

  8. To start SharePlex, do the following:

    1. Select the SharePlex Services tab.
    2. Select the port number of the SharePlex instance that you licensed.
    3. Click Start.
    4. Wait for Current State to display a message that the service started.

Set the SharePlex environment parameters

Perform these steps on a source cluster and on a target cluster, if applicable.

Set the SharePlex environment to point to the VIP alias and SharePlex variable-data directory.

  • SP_SYS_HOST_NAME directs SharePlex to use the VIP alias when any of its processes issues a name lookup, superseding the local system name. It ensures that sp_ctrl commands are directed to the correct host, in this case the cluster name, and it enables SharePlex to migrate properly during failover.
  • SP_SYS_VARDIR points to the variable-data directory that you installed on the shared disk. This is the active variable-data directory. Setting SP_SYS_VARDIR ensures that the current replication environment continues to be used by SharePlex after failover.

To set the environment on UNIX and Linux




To set the environment on Windows

Important! Do not set these parameters as environment variables, and do not set them on any systems outside the cluster, even if those systems are running SharePlex.

  1. On the primary node of the cluster, run the regedit program.
  2. Locate the following SharePlex entry:


  3. Expand the SharePlex node, then highlight the port number of the SharePlex instance you are configuring.

  4. In the Name column in the pane to the right, right-click the SP_SYS_VARDIR variable, then select Modify.
  5. Type the full path name of the shared variable-data directory in the Value Data field, then click OK.

  6. Right click the SharePlex port number, then click New and select String Value.
  7. Rename the new string to SP_SYS_HOST_NAME. Use all capital letters.
  8. Click outside the name box to set the new name of SP_SYS_HOST_NAME.
  9. Right-click SP_SYS_HOST_NAME, then select Modify.
  10. Type the VIP alias in the Value Data field, then click OK.

  11. Close the Registry Editor.
  12. Restart the SharePlex service for the changes to take effect.

Configure SharePlex

When you create the configuration file that directs SharePlex replication, you specify the tns_alias rather than an actual ORACLE_SID, as follows.

To capture from a source cluster

Specify the tns_alias on the o.datasource line of the file. This is the first line of the configuration file.

For example:


To post to a target cluster

Specify the tns_alias as the destination in the routing map.

For example (assumes the use of wildcards to specify objects):

expand hr.%     hr.%    inst_c@ora_b_sp

Activate replication

Once a source and target cluster (if applicable) are configured, you can populate a standalone or clustered target with a copy of the source data, while replication keeps track of transactional changes made by users on the source database. Use any of the Oracle-specific copy methods for activating replication from an active source. See the procedures listed in Activate replication in your production environment in the SharePlex Administration Guide for more information.

Add SharePlex to the cluster software

Incorporate SharePlex as a resource in the cluster software, and include it in the cluster failover routines so that it migrates with the other applications during failover. This ensures that the sp_cop process is started on the adoptive node by the cluster software. At minimum, this includes creating a startup script for SharePlex and a cluster script for SharePlex to handle failover. Note the following:

  • The sp_cop program is the only process that the cluster software should start. The sp_cop process must be allowed to start the other SharePlex processes. All SharePlex processes, except sp_cop, can be controlled through the sp_ctrl interface.
  • Do not attempt to start or stop sp_cop yourself through the command interface; otherwise the cluster software will attempt to restart it. If you need to stop sp_cop, use the cluster software commands.
  • If possible, configure SharePlex and Oracle into a single global cluster package. The combination of SharePlex and Oracle in the same package allows the cluster software to start and stop SharePlex and Oracle in the proper sequence if any component of the package fails. Configure Oracle to start before SharePlex.

  • Assistance for creating startup and cluster scripts is available through SharePlex Professional (PSO) Services.

System maintenance

Make certain your systems administrators understand that any changes or upgrades they perform to the operating system on any node in the cluster must be implemented on all nodes in the cluster so that SharePlex fails over to an identical environment.

Installation and setup for cloud-hosted databases


Overview of SharePlex setup on cloud databases

SharePlex supports databases installed as services of Amazon Web Services (AWS) and Microsoft Azure. To view the cloud databases that SharePlex supports, see Cloud support.

There are some differences in the way that SharePlex installs in an IaaS cloud environment and a PaaS cloud environment. These differences are only in the installation and configuration of SharePlex. Once installed and configured, SharePlex operates in the cloud the same way that it operates in on-premise installations.

Installation in an IaaS (accessible) environment

If your cloud database service is a true IaaS virtual computing environment, you can install and run a custom application environment, access the operating system, and manage access permissions and storage. In this environment, SharePlex is installed directly on the cloud server just as you would install it locally, without any special setup requirements.

In this environment, the following applies:

Installation in a PaaS (non-accessible) environment

If your cloud database is installed in a true PaaS environment, you do not have access to the underlying operating system, and you must install SharePlex on a server that is external to the cloud deployment. You then configure SharePlex to interact with the target database through a remote connection.

SharePlex can post to a supported target database in a PaaS environment, but it cannot perform capture functions because the binaries cannot be installed on the cloud server nor granted the appropriate privileges.

You can install SharePlex for a PaaS target in one of the following ways:

  • You can use your on-premise production source server to run all of the SharePlex replication components. In this setup, both source and target replication processes (and their queues) are installed on one server. The SharePlex Post process connects through a remote connection to the target cloud database.

    For more information, see Post to PaaS cloud from the source system on page 1.

    Note: In a high-volume transactional environment, the buildup of data in the post queues and the presence of multiple Post processes may generate unacceptable overhead for a production system. In that case, you should use an intermediary server.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating