Chat now with support
Chat with Support

SharePlex 9.0 - Preinstallation Checklist

System Requirements — SQL Server

This section contains information about SharePlex support for capture from a SQL Server source database and replication to supported targets.

SharePlex support for SQL Server as a target for Oracle data is documented in System Requirements — Oracle.

Supported versions and targets

SharePlex supports Capture for SQL Server versions 2012, 2014, and 2016 on Windows 2012 R2.


Target - Platform/Database

Windows 2012 R2 on-premise

Windows 2012 R2 on-premise

SQL Server 2012

SQL Server 2012

SQL Server 2014

SQL Server 2014

SQL Server 2016

SQL Server 2016


Oracle 11.2


Oracle 12.1


Linux RHEL 5.5 on-premise


Oracle 11.2


Linux RHEL 6.3 on-premise


Oracle 12.1


Solaris SPARC 11 on-premise


Oracle 11.2


Azure Windows 2012 R2 (IaaS)


SQL Server 2012


SQL Server 2014


SQL Server 2016


Azure SQL Database (PaaS)


SQL Server 2012


SQL Server 2014


AWS Linux EC2 (IaaS)


SQL Server




AWS Linux RDS (PaaS)


SQL Server



Conditions of support

This section shows the limitations of capturing from a SQL Server source.

  • SQL Server native replication and SharePlex replication cannot be used at the same time for the same database.
  • All SQL Server tables in the SharePlex replication configuration must be defined in the database with a primary key. A SharePlex key definition is not sufficient, nor can SharePlex use all columns as a key. You can use SharePlex filtering features in the configuration file to omit tables that do not have a primary key.
  • A transaction must COMMIT to the SQL Server source before it can be captured by SharePlex.
  • See the SharePlex Installation Guide for additional requirements and setup information.

Supported DML operations

SharePlex supports INSERT, UPDATE, and DELETE operations between SQL Server source tables and Oracle or SQL Server target tables.

Any SQL Server table can be replicated to an Oracle or SQL Server target if the target supports all of the column types that are being replicated.


SharePlex only replicates DML changes that are made to SQL Server source objects that are listed in the configuration file.

SharePlex requires SQL Server Replication to be installed on the source system. See the SharePlex Installation Guide for more information.

Supported DDL operations

SharePlex does not support the replication of SQL Server DDL operations.

Supported data types

SharePlex supports DML operations that contain the following SQL Server data types:

  • int
  • numeric
  • smallint
  • tinyint
  • float
  • real
  • date
  • datetime
  • datetime2
  • datetimeoffset
  • smalldatetime
  • time
  • char
  • text
  • varchar
  • nchar
  • ntext
  • nvarchar
  • binary
  • varbinary
  • image

Note: When replicating to an Oracle target, SharePlex queries the target database to determine the appropriate data type to use.

Supported SharePlex features — SQL Server to supported target

The following table shows whether or not SharePlex features are supported when SQL Server is the source.

SharePlex feature Supported with SQL Server Target Supported with Oracle Target
Replication between tables in same database No No
Replication between tables in different databases in the same or another SQL Server instance Yes Yes
Replication from SQL Server tables to any target where the version of SharePlex is earlier than 9.0. No No
Auto-add of new tables that satisfy a wildcard No No
flush command Yes Yes
reconcile command (target instantiation) Yes Yes
compare/compare using and repair/repair using commands No No
copy/copy using and append/append using commands No No
Hash horizontally partitioned replication No No
Column-based horizontally partitioned replication No No
Vertically partitioned replication Yes Yes
Column mapping Yes Yes
Key definition (SQL Server tables must have a defined key) No No
Build configuration with scripts No No
Named queues Yes Yes
Post Enhanced Performance No No
Transformation No Yes
Conflict resolution No Yes
Peer-to-peer replication (bi-directional) No No
Consolidated replication (many to one) Yes Yes
Broadcast replication (one to many) Yes Yes
Cascading replication (source-intermediary-target) Yes Yes
High availability replication (active/passive bi-directional) No No
Change history target (CDC) No Yes
Data encryption No No
Data compression No No
auth_hosts file No No
Monitoring scripts No No
SNMP monitoring No No
Continue posting on error (SP_OPX_CONT_ON_ERR) Yes Yes
Suspend on out of sync errors (SP_OPX_OUT_OF_SYNC_SUSPEND) Yes Yes
Reduced key (SP_OPX_REDUCED_KEY) Yes Yes
sp_ctrl commands See the command documentation in the Reference Guide. See the command documentation in the Reference Guide.
Logical Transaction Rollback on out-of-sync transactions No Yes

SharePlex pre-installation checklist



Review and satisfy all of the requirements in this checklist before installing SharePlex or before your SharePlex consultant arrives, if you have contracted with our Professional Services team.

Note: The requirements in this checklist apply to all source and target systems where SharePlex will be installed unless otherwise noted.

Network checklist

Requirement Completed? (Y/N)

Add SharePlex users and groups to the nameserver.

If you are installing SharePlex in a network managed by a nameserver such as NIS or NISPLUS, do the following before you install SharePlex:

  • Add SharePlex users to the nameserver.
  • Add the SharePlex groups to the nameserver.

The SharePlex security groups spadmin (administrator), spopr (operator), and spview (viewer) control access to SharePlex processes. Add each SharePlex user to one of these groups on the nameserver. For more information, see Assign SharePlex users to security groups.

To add the user groups:

  1. For NIS add the groups to the group.byname and group.bygid maps. For NISPLUS, add them to the group.org_dir table.
  2. Add the SharePlex Administrator user to the spadmin group on the nameserver.
  3. Create the spadmin group in the /etc/group file (on Unix and Linux) or the User Accounts control panel (Windows), and then add the SharePlex Administrator user to the group.

To add SharePlex groups to the local system after you install SharePlex, see Assign SharePlex users to security groups.


Ensure that SharePlex can resolve host names.

If you find that SharePlex cannot connect to a host, try mapping the host name to an alphanumeric alias in the following locations:

  • Network: The NIS and DNS servers
  • Unix and Linux: Local /etc/hosts file
  • Windows: Local hosts file

In these files, put each entry on an individual line. The following is an example, where sysA and sysB are aliases:   sysA   # source system   sysB   # target system


Resolve to the right network card

If you have multiple network cards on Windows, you must set the SP_SYS_HOST_NAME environment variable to the network card name or IP address that you want SharePlex to use as the local host. Otherwise, if the server reboots after the SharePlex configuration is activated, the IP address may bind to a different network card from the one that is bound in the replication configuration.

For more information about SharePlex environment parameters and how to set them, see the SharePlex Reference Guide.


(PostgreSQL) Add a source entry to the PostgreSQL pg_hba.conf file

For a PostgreSQL target (non-cloud), make certain that the PostgreSQL pg_hba.conf file has an entry for the SharePlex source server IP address, which gives that server access to PostgreSQL target server and its databases.

Example entry:

host    all     all     sourceip     md5

(Oracle) Allow access to Amazon EC2 instance

For an EC2 instance, make certain that the appropriate network group is set up to allow access to EC2 instances.


Verify the SharePlex port number.

By default SharePlex uses the port number 2100 (hex equivalent is 834) for both TCP/IP and UDP. If port 2100 is available to SharePlex, no further action is needed. You will need to enter the SharePlex port number during the installation procedure, at which time you can specify a different port number if needed.

Important! The SharePlex port number must be the same one on all machines in the replication configuration so that they can communicate through TCP/IP connections. Make certain the SharePlex port number is open for both TCP/IP and UDP on the firewall.


Verify TCP/IP settings

SharePlex replicates over any TCP/IP network connection. Typically, if all of the tables in a database are being replicated, SharePlex replicates about 33 percent of the redo log volume, the remainder being mostly maintenance data used by the Oracle software. The following is a formula for determining bandwidth.

(size of a redo log) x (number of log switches in 1 hour) x 1/3 = volume of data per hour

For example, if the redo logs are 20 MB in size, and they switch six times an hour, SharePlex will replicate approximately 40 MB each hour:

20 x 6 x 1/3 = 40 MB/hour


VerifyTCP protocol

SharePlex has been tested on IP v6 networks, but it is impossible to test all scenarios. See the System Requirements in the SharePlex Release Notes for more informationon.


Installer checklist

Requirement Completed? (Y/N)

Assign a directory to store the downloaded SharePlex installation package.

This directory requires approximately the following disk space:

  • Unix and Linux: 200 MB
  • Windows: 60 MB plus 400 MB of temporary disk space

It can be removed after SharePlex is installed.


Plan the SharePlex product directory.

You can create a directory for the SharePlex software files or let the SharePlex installer create it. This directory requires approximately the following disk space:

  • Unix and Linux: 120 MB
  • Windows: 600 MB plus 20 MB for the MKS Toolkit®

Install this directory on the following:

  • Unix and Linux: a separate filesystem from the one that contains the source Oracle instance or (if a target) the target database.
  • Windows: a separate internal hard drive or partition from the one that contains the Oracle instance or (if a target) the target database.

Do not install SharePlex on a raw device.


Plan the SharePlex variable-data (working) directory.

This directory is installed by the SharePlex installer with a name of your choosing. It contains the working data and varies greatly in size in correlation to the size of the redo data being generated. Install this directory on a separate filesystem from the one that contains the Oracle instance (or the target database, if this is a target) but not on a raw device.

To estimate the required disk space:

  1. Estimate the longest time that a replication outage can be tolerated.
  2. Use the following formula to estimate the amount of data SharePlex would replicate during that amount of time.

    [size of a redo log] x [number of log switches per hour] x .333 x [number of hours downtime] = required disk space

    For example:

    [500 MB redo log] x [5 switches per hour] x [.333] x [8 hours] = 6.5 GB disk space

To replicate data from more than one database or Oracle instance on a system, use a variable-data directory for each one. Ideally they should be on different filesystems.

Do not install the variable-data directory within the SharePlex product directory. Both directories contain identically named files, and SharePlex utilities that clean up the environment (if this becomes necessary) could remove the wrong files. You can install both directories under one parent directory if desired.

Note: Always monitor disk usage when there is an active SharePlex configuration, especially when there are unexpected peaks in user activity.


Install in a cluster (including Oracle RAC)

Most shared storage solutions can be used to house SharePlex. Such file systems include, but are not limited to:

  • Oracle Cluster File System (OCFS2)
  • Oracle Automatic Storage Management (ASM) Cluster File System (ACFS)
  • Oracle DataBase File System (DBFS)
  • OCFS2 Note: This file system must be mounted nointr. Both SharePlex and Oracle report interrupt errors if nointr is not specified.
  • Most general purpose cluster file systems

See Installation and setup for Oracle cluster for SharePlex installation requirements in a cluster. Many of those steps must be performed before you install SharePlex, while others are performed after installation.


Create the SharePlex security groups.

SharePlex provides three security groups to enable access control through sp_ctrl. On Unix and Linux, unless you install SharePlex as a root user, the SharePlex Administrator user and the SharePlex admin group must exist prior to installation. For more information, see Assign SharePlex users to security groups.

Note: If you install as root, you are prompted by the installer to create these groups.


Choose a DBA-privileged operating system group to own SharePlex.

The SharePlex Administrator user must be in the Oracle dba group. For Oracle RAC and ASM 11gR2 and above, the user must also be in the Oracle Inventory group. For example: $ useradd –g spadmin –G dba,oinstall. The membership in Oracle Inventory group must be listed explicitly in the etc/group file.


Get a valid SharePlex license key.

You must have a valid permanent or trial license key from Quest to run SharePlex. The installer prompts for the license key and the text string in the Site Message that Quest Software provides with the license.

The current license model for SharePlex is to license for a specific host, which depending on edition is licensed by core(s) or socket(s) and specific message repository (i.e. database, JMS/text files) etc. Specifics of license terms should be obtained from your account manager.


Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating