SharePlex runs as a service on the Windows platform. The service name is SharePlex port_number, where port_number is the port number associated with that SharePlex instance.
SharePlex is not installed as a Windows service during the initial installation. You must add and start the service through the SpUtils utility.
To add and start SharePlex as a service
The service is installed in auto-startup mode (start when the system starts) so that replication begins as soon as possible. To change startup status, use the Services applet of the Administrative Tools in the Windows Control Panel.
This section contains instructions for using the SharePlex uninstallation program to remove SharePlex from a system. The uninstaller permanently removes the replication environment from the system.
To preserve the replication environment, including the queues that store the data, you can install a SharePlex upgrade or reinstall the current version, rather than uninstall SharePlex. Before you upgrade or reinstall SharePlex, see the Release Notes for the version you are installing to determine if there are any special upgrade or installation requirements.
When SharePlex was installed, a file named install.log was installed in the SharePlex product directory. This file contains a record of all files created on the system by the installation program. When you run the uninstall program to remove SharePlex, it reads install.log to determine which files to remove.
If you select the Automatic uninstall option, it removes the following components for all instances of SharePlex (all SharePlex services on all ports):
Use the Custom uninstall option to remove specific files while leaving the others intact.
The uninstall program does not remove the following components.
Perform these tasks in the order shown.
Before you remove the SharePlex software from the system, follow these steps to stop and remove each SharePlex service on the system. If you remove SharePlex first, you cannot use SpUtils to stop and remove the service and must do so from the Services utility of the Windows Control Panel.
From Start menu, click Programs, then navigate to the SharePlex program folder and click Uninstall. Alternatively, you can use the Windows Control Panel as you normally would to remove software.
In the Select Uninstall Method dialog box, select an uninstall option.
Select Automatic to remove everything listed in Files removed by the uninstall program. This is the recommended procedure because it is the cleanest way to remove SharePlex from the system. Click Finish to execute the uninstallation.
Select Custom to selectively remove files. Use this option only if you must retain some files while deleting others. You receive a series of prompts to remove different sets of files.
The MKS Platform Components software and NuTCRACKER service (and corresponding Registry entries) are removed when you uninstall SharePlex using the Automatic option.
NOTE: Changing and removing Windows Registry components may be harmful to the system. Contact your System Administrator for assistance if needed.
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432\Node\Datafocus
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432\Node\Mortice Kern Systems
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432\Node\Quest Software
Important! If you intend to reinstall SharePlex or MKS Toolkit, they will not reinstall unless these Registry entries are removed.
This uninstaller does not remove the SharePlex database objects. All SharePlex objects are installed in the SharePlex schema or database that was specified when the Database Setup portion of the installation was performed.
The following describes the items that are installed during the SharePlex setup process.
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 basic directory structure appears as follows.
Sub-directory | Contents |
---|---|
BACKUP | Uninstall information |
bin | SharePlex executable files |
config | Internally used content. |
data | Default parameter settings |
doc | Catalog of exception messages |
lib | SharePlex shared libraries |
log | SharePlex log files |
mks_oe | Runtime installation files for third-party software used by SharePlex. |
util | SharePlex utilities |
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. |
downgrd | Information about SharePlex targets that are a lower version than the source. |
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. |
Much of the replication process is controlled and tracked through a series of internal objects 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 objects are used for all databases. Most are used for Oracle databases. If you do not see an object in your database, it is not relevant to the database, or the information is stored internally within the SharePlex configuration. If you see an object that is in your database but not in this list, it is not being used in the current release.
Table |
Object type |
Description |
---|---|---|
DEMO_SRC |
Table |
Used as the source table for the SharePlex demonstrations. |
DEMO_DEST |
Table |
Used as the target table for the SharePlex demonstrations. |
SHAREPLEX_ACTID |
Table |
Used by Capture to checkpoint its state. |
SHAREPLEX_ANALYZE |
Table |
Used by the analyze command. |
SHAREPLEX_CHANGE_OBJECT |
Table |
Used by users to stop and resume replication for an object. |
SHAREPLEX_COMMAND |
Table |
Used for the flush, abort and purge commands. |
SHAREPLEX_CONFIG |
Table |
Used by the activation and Capture processes to mark the start of a new activation. |
SHAREPLEX_DATA |
Table |
Used by the SharePlex wallet for Oracle TDE replication. |
SHAREPLEX_DATAEQUATOR |
Table |
Used by the compare and repair commands and the Post process to synchronize their operations. |
SHAREPLEX_DATAEQUATOR_INSERT_TEMP |
Table |
Used as a temporary table by the compare and repair commands. |
SHAREPLEX_DATAEQUATOR_UPDATE_TEMP |
Table |
Used as a temporary table by the compare and repair commands. |
SHAREPLEX_DATAEQUATOR_DELETE_TEMP |
Table |
Used as a temporary table by the compare and repair commands. |
SHAREPLEX_DDL_CONTROL |
Table |
Used to refine control of DDL that is enabled for replication by the SP_OCT_REPLICATE_ALL_DDL parameter. |
SHAREPLEX_JOBID |
Sequence |
Used by the sp_cnc process and the compare, repair, and copy commands to provide a unique job ID. |
SHAREPLEX_JOBS |
Table |
Used by the sp_cnc process and the compare, repair, and copy commands to store information about a job. |
SHAREPLEX_JOB_STATS |
Table |
Used by the sp_cnc process and the compare, repair, and copy commands to store information about a job. |
SHAREPLEX_JOBS_CONFIG |
Table |
Used by the disable jobs and enable jobs commands. |
SHAREPLEX_LOB_CACHE |
Table |
Used by the Capture process when processing VARRAYs stored as LOB. |
SHAREPLEX_LOBMAP |
Table |
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 |
Table |
Used by the Capture process to track inactive RAC instances. |
SHAREPLEX_MARKER |
Table |
Used by the Read process when PK/UK logging is not enabled. |
SHAREPLEX_OBJMAP |
Table |
Used by the activation and Capture processes to define the objects in replication. |
SHAREPLEX_PARTITION_CACHE |
Table |
Used by the Capture process to map Oracle partition IDs to tables in replication. |
SHAREPLEX_SYNC_MARKER |
Table |
Used by the copy command and the Read and Post processes to sync their operations. |
SHAREPLEX_TRANS or SHAREPLEX_OPEN_TRANS |
Table |
Used by the Post process to store checkpoints and to mark transactions that were applied in a primary-to-primary configuration. |
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.
On Windows systems, SharePlex installs the following Registry entries.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy Cookie Preference Center