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

Appendix A: Advanced installer options

Appendix A: Advanced installer options

The use of additional command line options when installing SharePlex is usually not necessary. These options are typically employed when working with Support to resolve specific issues.

The installer command line options and their descriptions follow:


tpm [<options>] [ [<package> | <location>] ... ]



-v, --verbose Turns verbose mode on

-h, -?, --help Prints out this message

--debug Starts the interactive debugger

--info Print information about installed



--install Perform product installation

--remove Perform product deinstallation

--commit Commit last installation

--revert Revert last installation

-t, --tmp <directory> Temporary directory location

-d, --directory <directory> Working directory

-f, --force Unconditionally update existing files

--no-cleanup Do not perform cleanup on failure

--nocleanup Same as --no-cleanup, for compatibility

--list List the content of the archive

--extract Extract the archive into the current directory

-r, --responses <yaml file> Use the responses from a specified file

-D, --defaults Accept default answers

-l, --log Leave the installation log file


Provides package management facilities. Packages can be installed, removed, reverted or committed. The utility also figures out its role based on the command name of its invocation path. For example, "tpm-install" is treated as "tpm --install", "tpm-remove" as "tpm --remove", etc.

It can also be invoked as part of a self extracting package invocation, in which case it is treated as "tpm --install".

Note: All command line options for the .tpm file are preceded by two dashes.

Appendix B: Install SharePlex as root

Appendix B: Install SharePlex as root

You can install SharePlex as a root user. When you install as a root user, the installer prompts you to select whether or not to create the SharePlex user groups. When the installer creates the groups, it adds the SharePlex Administrator user to the spadmin group. For more information about these groups, see Assign SharePlex users to security groups.

In a cluster, the installer adds the SharePlex groups to the primary node, but you must add them to the other nodes yourself.

Additionally, see Network checklist for instructions on adding the groups to a nameserver.

To install as root

    1. Log in to the system as a root user.
    2. Copy the SharePlex installer file to a temporary directory where you have write permissions. The installer file has a naming format of:


    3. Change the permissions of the file as follows:

      # chmod 555 SharePlex-release#-OracleVersion-platform.tpm

    4. Run the installer as directed in Install SharePlex on Linux and UNIX.

Appendix C: SharePlex installed items

Appendix C: SharePlex installed items

The following describes the items that are installed during the SharePlex setup process.

SharePlex Directories

SharePlex uses two main directories:

The product directory: This is the SharePlex installation directory, where the SharePlex programs and libraries are stored.

The variable-data directory: This is the SharePlex working directory, where the queue files, log files and other components that comprise the current replication environment are stored.

Note: These directories are often referred to as productdir and vardir, respectively.

Do not remove, rename or edit any files or directories installed by SharePlex. Some directories contain hidden files that are essential for replication. Some files appear empty but must exist under their original names because they are referenced by one or more SharePlex processes. Some items in the directories are for use only under the supervision of Quest Technical Support.

Programs meant for general use in a production environment are documented in the published SharePlex documentation. If you do not find documentation for a program in a SharePlex directory, do not attempt to run it. Contact Quest Technical Support first.

The directory structure and files within the two main SharePlex directories differs slightly between the UNIX and Windows platforms. Files and directories can vary from version to version of SharePlex, but the basic structure appears as follows.

SharePlex product directory
Sub-directory Contents
bin SharePlex executable files
data Default parameter settings
install (Unix and Linux only) Scripts related to installation, licensing and upgrades
lib SharePlex shared libraries
util SharePlex utilities
.app-modules (Unix and Linux only) Hidden internal directory that contains raw executables. Do not use the contents of this directory to launch processes.
.meta-inf (Unix and Linux only) Hidden internal directory that contains meta information used during the installation process.
SharePlex variable-data directory
Sub-directory Contents
config Configuration files for this installation of SharePlex.
data Status Database, configuration activation information, user-defined parameter settings, and other user-defined files that direct replication activities.
db Configuration internal database for each activation of a configuration file.
dump Core files (if a process fails)
log SharePlex log files
rim Queue files (working data files)
save Information about active and inactive configurations.
state Information about the current state of SharePlex when a configuration is active, such as the object and sequence caches.
temp Used by the copy and append features and other SharePlex sync-related processes.
oos Stores the transactions that contain out-of-sync operations when the SP_OPO_SAVE_OOS_TRANSACTION parameter is enabled.

SharePlex Tables

Much of the replication process is controlled and tracked through a series of internal tables that are installed into the source or target database during the installation of SharePlex. They are essential for SharePlex to operate, so do not alter them in any way.

NOTE: Not all tables are used for all databases. If you do not see one, it is not relevant to the database. If you see one not in this list, it is not being used in the current release.

Table Description
DEMO_SRC Used as the source table for the SharePlex demonstrations.
DEMO_DEST Used as the target table for the SharePlex demonstrations.
SHAREPLEX_ACTID Used by Capture to checkpoint its state.
SHAREPLEX_ANALYZE Used by the analyze command.
SHAREPLEX_CHANGE_OBJECT Used by users to stop and resume replication for an object.
SHAREPLEX_COMMAND Used for the flush, abort and purge commands.
SHAREPLEX_CONFIG Used by the activation and Capture processes to mark the start of a new activation.
SHAREPLEX_DATA Used by the SharePlex wallet.
SHAREPLEX_DATAEQUATOR Used by the compare and repair commands and the Post process to synchronize their operations.
SHAREPLEX_DATAEQUATOR_INSERT_TEMP Used as a temporary table by the compare and repair commands.
SHAREPLEX_DATAEQUATOR_UPDATE_TEMP Used as a temporary table by the compare and repair commands.
SHAREPLEX_DATAEQUATOR_DELETE_TEMP Used as a temporary table by the compare and repair commands.
SHAREPLEX_DDL_CONTROL Used to refine control of DDL that is enabled for replication by the SP_OCT_REPLICATE_ALL_DDL parameter.
SHAREPLEX_JOBS* Used by the sp_cnc process and the compare, repair, and copy commands to store information about a job.
SHAREPLEX_JOB_STATS Used by the sp_cnc process and the compare, repair, and copy commands to store information about a job.
SHAREPLEX_JOBS_CONFIG Used by the disable jobs and enable jobs commands.
SHAREPLEX_LOB_CACHE Used by the Capture process when processing VARRAYs stored as LOB.
SHAREPLEX_LOBMAP Used by the Capture process to map LOBIDs and rows when a table with LOB columns does not have PK/UK logging enabled.
SHAREPLEX_LOGLIST Used by the Capture process to track inactive RAC instances.
SHAREPLEX_MARKER Used by the Read process when PK/UK logging is not enabled.
SHAREPLEX_OBJMAP Used by the activation and Capture processes to define the objects in replication.
SHAREPLEX_PARTITION_CACHE Used by the Capture process to map Oracle partition IDs to tables in replication.
SHAREPLEX_SYNC_MARKER Used by the copy command and the Read and Post processes to sync their operations.




Used by the Post process to store checkpoints and to mark transactions that were applied in a master-to-master configuration.

* Additionally, SharePlex creates the SHAREPLEX_JOBID sequence for use by the sp_cnc process and the compare, repair, and copy commands to provide a unique job ID.

MKS Toolkit

On the Windows platform, SharePlex installs the MKS Toolkit® operating environment from Parametric Technology Corporation (PTC), formerly known as Mortice Kern Systems NuTCRACKER. This software enables SharePlex to be ported to all supported platforms in a uniform manner.

SharePlex users have no interaction with the MKS Toolkit software, other than to ensure that its service is running when the SharePlex service is running. The MKS Toolkit is installed in automatic startup mode by default when it is installed during SharePlex installation.

The default folder for MKS Toolkit is C:\Program Files\MKS Toolkit, but a different folder might have been selected during installation. The MKS Toolkit files must not be moved after they are installed.

SharePlex Registry Entries

On Windows systems, SharePlex installs the following Registry entries.

  • \HKEY_LOCAL_MACHINE\Software\Wow6432node\Quest Software\SharePlex: This contains the SharePlex environment information and is where any user-created variables must be entered, such as SP_SYS_VARDIR. Each instance of SharePlex is defined in the Registry as a port number, and each has its own set of environment variables.
  • \HKEY_LOCAL_MACHINE\Software\Wow6432node\Mortice Kern Systems: This contains Registry entries for the MKS Toolkit® operating environment.
  • \HKEY_LOCAL_MACHINE\Software\Wow6432node\Datafocus: This contains Registry entries for the MKS Toolkit® operating environment.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating