Chat now with support
Chat with Support

SharePlex 8.6.6 - Installation Guide

About this Guide Conventions used in this guide Introduction to SharePlex SharePlex pre-installation checklist Set up SharePlex in an Oracle cluster Set up SharePlex on Amazon Cloud Download SharePlex UNIX Installation and Setup Windows Installation and Setup Assign SharePlex users to security groups Basic SharePlex demonstrations Advanced SharePlex Demonstrations Solve Installation Problems Uninstall SharePlex SharePlex Utilities Appendix A: Advanced installer options Appendix B: Install SharePlex as root Appendix C: SharePlex installed items

Run the installer in unattended mode

UNIX Installation and Setup > Run the installer in unattended mode

SharePlex can be installed unattended through the use of a response file. This installation method speeds the installation of multiple SharePlex instances. The file supplies responses to the standard installer prompts, while providing on screen status information.

Note:When running in unattended mode, the installation process does not call the system password utility. If you create a new SharePlex user during the installation, that user will remain locked until the password is set manually.

Response files that you can edit are located in the install subdirectory of the SharePlex product (installation) directory:


Enter responses in the file

Important! The response file contains two sections. Only the top section is user configurable. Do not edit the bottom section. The bottom section begins with the line "Do not change settings that appear below."

Edit the top section of the response file to provide the responses for the installation. Only edit the values to the right of the colon, and make certain there is a space between the colon and the response.

The following example is for non-root installation:

# To install SharePlex with the unattended option please

# modify the settings below. You may safely modify only the values

# to the right of the colon, and the colon must be immediately

# followed by a space. Editing the values to the left of the colon

# may impact the unattended install causing the process to become

# interactive.


SharePlex Admin group: spadmin

product directory location: /home/splex/proddir

variable data directory location: /home/splex/vardir

# not required for Open Target installations # ORACLE_SID that corresponds to this installation: oracledb

# not required for Open Target installations# ORACLE_HOME directory that corresponds to this ORACLE_SID: /home/oracle/products/version

TCP/IP port number for SharePlex communications: 2100


the customer name associated with this license key: SharePlex_Trial

To run the response file

From the command shell of the operating system, run the .tpm installation file with the -r option followed by the full path to the response file.

# ./installation_file -r /users/shareplex/product.rsp

Next Steps

For additional setup requirements, see the Next Steps section in one of the following depending on the platform:

Install SharePlex on Linux/Unix for Oracle Database

Install SharePlex on Linux/Unix for Open Target Databases

Windows Installation and Setup

Install SharePlex on Windows


Install SharePlex on Windows

Windows Installation and Setup > Install SharePlex on Windows

Read this before you begin:

  • These instructions assume that you understand and satisfied all requirements in the SharePlex SharePlex preinstallation checklist.
  • Perform the installation steps on all Windows machines involved in SharePlex replication. On Windows, SharePlex must be installed on all nodes of a cluster, on the same port number, with identical path names. This is required to make the binaries and the required MKS Toolkit components available to all nodes, and to establish Registry entries.

To run the installer

  1. Log into Windows as the SharePlex Administrator.
  2. (Reinstallation only)

    1. Run SpUtils from the shortcut on the Windows desktop. If the system is running Windows 2008 or higher, run SpUtils as an Administrator.
    2. Select the SharePlex Services tab.
    3. Select the correct port, and then stop the SharePlex service.
    4. Close the utility.
  3. Run the sp_setup installation program and follow the prompts:

    Prompt Input
    Destination folder

    SharePlex installation directory (known as the product directory).

    Specify an empty existing directory or a new one to be created.

    Component selection Specify the database for which you are installing SharePlex.
    Port number

    The port number on which this instance of SharePlex will run.

    The default is 2100. Do not use port 2101. That port is reserved for the SpRemote utility.

    Variable Data directory

    The directory where SharePlex stores its working files and data.

    Specify an empty existing directory or a new one to be created. To avoid permissions errors during runtime, do not install the variable-data directory in the Program Files directory.

    Program Manager group

    The folder in the Programs menu where SharePlex programs will be launched.

    MKS Platform Components

    Appears if SharePlex was never installed on the system or if this is a reinstallation. Accept the default Program Files location or specify a different one.

    If prompted to restart your system, you can postpone the restart until after you finish this installation.

    Confirm installation Confirm the installation information.
    SharePlex license

    Click Add License. Type or paste the following exactly as received from Quest Software, including any spaces:

    1. License Key: The license key, which is case sensitive.
    2. Customer Name: The Site Message text that was included with the license. The name is case-sensitive.
    3. Click OK.

    If you do not have a license, click Cancel. The installation succeeds without a license, but SharePlex cannot be started. You can add the license later from the License Key tab of the SpUtils utility, which is installed on the Windows desktop.


    If you were prompted to restart the system after you installed the MKS Toolkit files, you may do so after exiting the installer.

    Proceed to Next Steps.

Next steps:

The following setup tasks must be finished before you start up replication.

Task Description
Run setup for the database

Run Database Setup to set up an account and some objects in the database to support SharePlex:

For other Open Target target databases, use the connection command to supply connection information for the Post process to use. This can be done at any time before starting replication. See the SharePlex Administration Guide for more information about configuring an Open Target database for Post.

Install the SharePlex service SharePlex is not installed as a Windows service during an initial installation. To install the SharePlex service, see Install the SharePlex service.
Patch SharePlex If you downloaded patches for this version of SharePlex, apply them now.

Setup in a cluster

If installing SharePlex in a cluster, see Set up SharePlex in a Windows cluster.

Set up security See Assign SharePlex users to security groups.
Configure the MKS Toolkit See Change global settings in the MKS toolkit.
Repeat Repeat all of the installation procedures for all Windows machines that will be involved in SharePlex replication.
Multi-instance configurations

To install multiple instances of SharePlex on this system, such as to support consolidated replication, see the SharePlex Administrator’s Guide for the correct setup. Each instance of SharePlex must be installed on a different port number.

Configure SharePlex in a Windows Cluster

Windows Installation and Setup > Configure SharePlex in a Windows Cluster

Summary of these steps

In the following procedures, you will:

  • Incorporate SharePlex into the cluster environment.
  • Set the SP_SYS_HOST_NAME variable in the Windows Registry.
  • Set the SP_SYS_VARDIR environment variable in the Windows Registry to point to the shared variable-data directory.

Setting environment variables in the Registry

SharePlex gets its environment information from the Windows Registry. The SharePlex environment variables SP_SYS_VARDIR and SP_SYS_HOST_NAME must be set in the Registry to the global cluster package name that is associated with the floating IP address. The global cluster package name is the alias that you created in the hosts file, as directed in the Installer Checklist.

  • SP_SYS_HOST_NAME directs SharePlex to use the alias when any of its processes issues a name lookup (through gethostname), superseding the local system name. It ensures that sp_ctrl commands are directed to the correct host, in this case the global cluster package 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.

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.

To set the SharePlex variables in the Registry

  1. Run the regedit program.
  2. Locate the following SharePlex entry:


  3. Expand the SharePlex node, then highlight the port number.

  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 global cluster package name in the Value Data field, then click OK.
  11. Close the Registry Editor.
  12. Restart the SharePlex service for the changes to take effect.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating