Chat now with support
Chat with Support

SharePlex 11.2 - Installation and Setup Guide

About this Guide Conventions used in this guide Revision History Installing and Setting up SharePlex on an Oracle Source
SharePlex Pre-installation Checklist for Oracle Download the SharePlex installer Install SharePlex on Linux and UNIX Set up an Oracle environment for replication Set up replication from Oracle to a different target type Installation and Setup for Cloud-Hosted Databases for Oracle Installation and setup for remote capture Installation and setup for HA cluster Generic SharePlex demonstration for Oracle Advanced SharePlex demonstrations for Oracle Database Setup Utilities Solve Installation Problems for Oracle
Installing and Setting up SharePlex on a PostgreSQL Database as Source and Service
SharePlex Pre-installation Checklist for PostgreSQL Download the SharePlex installer for PostgreSQL Install SharePlex on Linux for PostgreSQL as a Source Set up Replication from PostgreSQL to Supported Target Types Installation and Setup for Cloud-Hosted Databases for PostgreSQL Installation and Setup for Remote Capture for PostgreSQL Install SharePlex on PostgreSQL High Availability Cluster Generic SharePlex Demonstration for PostgreSQL Advanced SharePlex Demonstrations for PostgreSQL Database Setup for PostgreSQL Database Setup for PGDB as a Service Solve Installation Problems for PostgreSQL
Assign SharePlex users to security groups Solve Installation Problems Uninstall SharePlex Advanced installer options Install SharePlex as root SharePlex installed items

Network checklist for PostgreSQL

Requirement Completed? (Y/N)

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:

Unix and Linux: Local /etc/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


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 TCP/IP on the firewall.


Verify TCP/IP settings for PostgreSQL:

SharePlex replicates over any TCP/IP network connection. Typically, if all of the tables in Postgres database are being replicated, SharePlex processes about 54 percent of the WAL file data for replication, the remainder being mostly for internal data used by the Postgres engine for maintenance.

So if WAL file is of 16 MB size (default setting), and all user tables in DB are in replication, then SharePlex will consume approximately 8.6 MB (16 x 0.54) of data for replication.

The following is a formula for determining bandwidth.

(size of a WAL file) x (number of WAL file switches in 1 hour) x 0.54 = volume of data per hour.

For example, if WAL file is of 16 MB in size, and they switch 5 times an hour, SharePlex will process approximately 43.2 MB each hour for replication:

16 x 5 x 0.54 = 43.2 MB/hour


Installer checklist for PostgreSQL

Requirement Completed? (Y/N)

Assign a directory to store the downloaded SharePlex installation package.

This directory requires approximately the following disk space:

  • Linux: 200 MB

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:

  • Linux: 600 MB

Install this directory on the following:

  • Linux: a separate filesystem from the one that contains the 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 volume of data being generated. Install this directory on a separate file system from the one that contains the database, 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 WAL log] x [number of log switches per hour] x .54 x [number of hoursdowntime] = required disk space

    For example:

    [500 MB WAL log] x [5 switches per hour] x [.54] x [8 hours] = 10.54 GB disk space

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

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 peaks in transaction activity.


Create the SharePlex security groups.

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

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


Get a valid SharePlex license key.

You must have a valid permanent, term, or trial license key from Quest to run SharePlex. SharePlex licenses have validity and usage limits according to specific platforms. For example, you must have a PostgreSQL license to use a PostgreSQL database and a Kafka license to use the Kafka platform.

Additionally, SharePlex supports multiple keys for situations where customers need two platforms on one server. For example, if a user is replicating data from an Oracle source to a Kafka target, where one SharePlex instance is serving as both the source and target, the SharePlex server would require both Oracle and Kafka licenses.

NOTE: To install a trial version of SharePlex, users need to select the All Platforms option when prompted during installation of SharePlex or while running the splex_add_key utility.

SharePlex licensing information can be found in the Quest Software Product Guide. Please contact your account manager if you have questions.


Linux system checklist for PostgreSQL

Requirement Completed? (Y/N)

Confirm that the platform is supported.

Review the SharePlex Release Notes to make certain your operating system is supported.


Allocate at least 4 GB of memory for SharePlex processes.

Plan for per-process memory up to 256 MB. This recommendation enables the Post and Read processes to allocate larger sets of memory when necessary.


Set the number of semaphores per process.

Semaphores help ensure the stability of the SharePlex processes. The required SharePlex settings depend on the platform, as follows:

Red Hat Linux:

  • semmni*: 70
  • semmns*: 255
  • semmnu: 255
  • semmsl: 128
  • semopm: 64
  • semume: 255
  • shmmax: 60 MB
  • shmmin: 1MB
  • shmmni: 100
  • shmseg: 26

*These are additive. Add the database minimum values to the SharePlex minimum values to determine the correct setting.

An alternative is to set the value to the number of queues you will be using plus 2.


Set the ulimit (number of system file descriptors) to as close to 1024 as possible.

The ulimit can be set either as a system hard limit or a session-based soft limit, as follows:

  • Set a hard limit: (Recommended) A root user and system restart are required to change the hard limit, but the value remains fixed at the correct level to support SharePlex. Consult your System Administrator for assistance.
  • Set a soft limit: A soft limit setting stays in effect only for the duration of the sp_cop session for which it was set, and then it reverts back to a default value that may be lower than the hard limit and too low for SharePlex.

Set soft and hard limits for the SharePlex user

Set a soft limit and a hard limit for nproc and nofile for the SharePlex O/S user in the /etc/security/limits.conf file.

  • shareplex O/S user soft nproc 2048
  • shareplex O/S user hard nproc 16384
  • shareplex O/S user soft nofile 1024
  • shareplex O/S user hard nofile 65536

As an alternative, you can simply use the setting for the PostgreSQL O/S user.


Set core file parameters.

  • Set the system core dump block size as large as system resources can accommodate, at minimum 1.5 million blocks. The default is usually 0. Core files help Quest support representatives resolve SharePlex support cases. Higher size settings ensure that enough data is captured to be useful.
  • Set the core file output location to the dump sub-directory of the SharePlex variable-data directory.
  • Set the naming convention of core files to either core or

Note: SharePlex renames all core files named core to, except for those generated by sp_cop.

If these requirements are not met, the SharePlex event log might report that a core file was not generated, even though a file exists.


Install the ksh shell.

Install the ksh shell before you install SharePlex. The SharePlex monitoring scripts and other features required this shell.

A version of ksh called pdksh is included with the Red Hat Linux builds. Refer to the Red Hat Linux documentation for more information.


Install Native POSIX Threading Library (NPTL)

Quest recommends using the Native POSIX Threading Library (NPTL) on Linux. NPTL is faster and behaves more like other Unix operating systems than LinuxThreads. Although LinuxThreads can be enabled per process by using the LD_ASSUME_KERNEL environment variable, setting that variable adversely affects the performance of SharePlex. If LD_ASSUME_KERNEL is employed, use a setting of 2.4.21.


Amazon EC2 checklist

Requirement Completed? (Y/N)

Install on multiple EBS volumes

  • Install the database and SharePlex on Amazon Elastic Block Storage (EBS). An EBS volume is persistent storage, whereas the default Amazon storage is non-persistent and data is lost when the instance shuts down. EBS volumes also provide better performance. Minimum size for a volume is 1GB.
  • To optimize disk performance, create multiple EBS volumes and combine them by using software RAID. According to benchmarks, the optimal number of EBS volumes is 8.

Assign Elastic IP addresses

Amazon Elastic IP addresses are static, which satisfy SharePlex requirements. An Elastic IP must be created and assigned to both the source and target machines that will be used with SharePlex.


Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating