Chat now with support
Chat with Support

SharePlex 9.2.3 - Installation and Setup for SQL Server Source

About this Guide Conventions used in this guide SharePlex pre-installation checklist Download the SharePlex installer Install SharePlex on Linux and UNIX Install SharePlex on Windows Assign SharePlex users to security groups Set up replication between SQL Server databases Set up replication from SQL Server to a different target type Generic SharePlex demonstration-all platforms Solve Installation Problems Database Setup Utilities General SharePlex Utilities Uninstall SharePlex Advanced installer options Install SharePlex as root Run the installer in unattended mode SharePlex installed items

Install SharePlex on Windows



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, install SharePlex on all nodes of each 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 in to 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.

    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
Install the SharePlex service For more information, see Install the SharePlex service.
Patch SharePlex If you downloaded patches for this version of SharePlex, apply them now.
Run sp_security

Run “sp_security –setup” to specify whether or not to enable SSL/TLS for all network traffic. When enabled, SSL/TLS is used for network communications between the SharePlex instances on the source and target systems. For more information, see “Configure Security Features” in the SharePlex Administrator Guide.

Perform Database Setup and other setup tasks

If installing SharePlex for a SQL Server source database, run the Database Setup utility. For more information, see Database Setup for SQL Server.

If installing SharePlex for an Open Target database, perform required additional setup:

Set up replication from SQL Server to a different target type

Assign users to security groups For more information, see Assign SharePlex users to security groups.
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 Run multiple instances of SharePlex in the SharePlex Administrator’s Guide. Each instance of SharePlex must be installed on a different port number.

Assign SharePlex users to security groups




The SharePlex security groups provide access control to the SharePlex command and control system. Without proper configuration of these groups, anyone with permissions on the system can use the commands that view, configure, and control data replication.

Overview of SharePlex security groups

To monitor, control, or change SharePlex replication, a person must be assigned to one of the SharePlex security groups on the systems where he or she will be issuing commands. Each group corresponds to an authorization level, which determines which SharePlex commands a person can issue. To execute a command, a user must have that command’s authorization level or higher.

Use the authlevel command to determine your authorization level for issuing SharePlex commands on a system.

Description of the SharePlex security groups

Refer to the following table to determine the group and authorization level that you want to grant each SharePlex user.

User Authorization Levels and Roles
Auth level User type User group User roles
1 Administration spadmin*

You need at least one user with Administrator rights on each source and target system.

Can issue all SharePlex commands. Commands that can only be issued by a SharePlex Administrator are:

  • startup, shutdown
  • all configuration commands relating to an active configuration
  • all parameter commands except list param
  • start capture
  • stop capture
  • abort capture
  • truncate log
2 Operator spopr Can issue all SharePlex commands except those listed above.
3 Viewer spview Can view lists, status screens, and logs to monitor replication only.

Note: The default name for the SharePlex administrator group is spadmin, but you can designate any group or specify any name for that group during installation.

Related Documents