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

Strategies for information availability

Introduction to SharePlex > Strategies for information availability

Because SharePlex replicates over LAN and WAN connections, you can put a replica database to work as a reliable, continuously updated alternate database that can be used in many different ways. The following strategies enable you to get the right data to the people who need it, when they need it.

Reporting instances

Targets maintained by SharePlex are ideal for offloading report and query processing because they are accessible while being kept up-to-date, and they can be optimized with keys and indexes designed for optimal query performance. You can run reports all day long, without complaints about performance from your OLTP users. Even during busy reporting times such as the end of the month or quarter, application response time will be unaffected by heavy reporting. And, your organization’s decision-makers will appreciate the accuracy of the data reflected in the reports.

Broadcast and cascade

When many remote users access or use data stored in a primary database, you can move their processing to one or more secondary databases that are kept current through SharePlex replication. That way, you can keep the primary database and system optimized for transactions. SharePlex also can cascade ndata through an intermediary system to remote systems, providing access for remote users who have no direct network connection to the primary database.

Data warehousing

SharePlex can replicate from numerous source systems to one target system. It is ideal for consolidating data in a data warehouse or a data mart so that information is available enterprise-wide for queries and reports. A high degree of granularity in the data that you replicate and the option to transform replicated data to conform to a different target structure are unique SharePlex features that enable you to populate your data warehouse with the specific, timely information that users need to make good decisions.

High availability and disaster recovery

SharePlex can be used to maintain duplicate databases over local or wide-area networks. Production can move to the alternate sites in an emergency or in a planned manner when routine maintenance is performed on the primary server. SharePlex replication enables the secondary database to be used for queries and reporting.

Figure 1: SharePlex replication strategies at a glance

Test before you deploy

Before you implement SharePlex on production systems, Quest recommends performing tests in a mirror of the production environment to ensure that you configured SharePlex properly to support your requirements. Testing can uncover issues such as configuration errors and unexpected environmental issues, for example network or resource issues that affect replication performance or availability.

Additionally, it is assumed that your organization has in place an infrastructure that supports the use of enterprise applications such as SharePlex. These include, but are not limited to, the following:

  • Availability and use of the database and SharePlex documentation
  • Training programs for users
  • Rollout and upgrade plans that ensure minimal interruption to business. When SharePlex is implemented as part of an application’s infrastructure, it is strongly recommended to test new application functionality in conjunction with SharePlex in a non-production environment.
  • Database or system maintenance procedures that consider SharePlex dependencies, such as the proper shutdown of SharePlex processes and the preservation of unprocessed redo to accommodate system or database maintenance.
  • Sufficient security that prevent unauthorized persons from accessing SharePlex data records or making configuration changes.

The SharePlex Professional Services team can help you prepare for, install, and deploy SharePlex in your environment.

SharePlex pre-installation checklist

SharePlex preinstallation 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. The groups are described in 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


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.

Note: In Oracle 9.2.x, port 2100 is used by an Oracle XML daemon, so it cannot be used by SharePlex.

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


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 on the correct node 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

In a cluster, the SharePlex working files must be available to all nodes in a cluster to support seamless failover, as follows:

Unix and Linux:

The SharePlex product and variable-data directories must be installed on a shared, non-raw disk, separate from any database files, that can be mounted on any cluster node.


Product directory:

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. Quest recommends providing SharePlex with an internal hard drive or partition that is dedicated and separate from the database.

Variable-data directory:

The SharePlex variable-data directory must be installed on a shared disk that can be mounted on any Windows cluster node. The installer installs a variable-data directory on each node, but you will configure SharePlex to use the one on the shared disk during the post-installation procedure.

See Configure SharePlex in an Oracle cluster for additional SharePlex 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. 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