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:
USAGE
tpm [<options>] [ [<package> | <location>] ... ]
OPTIONS
-v, --verbose Turns verbose mode on
-h, -?, --help Prints out this message
--debug Starts the interactive debugger
--info Print information about installed
packages
--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
DESCRIPTION
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.
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
Copy the SharePlex installer file to a temporary directory where you have write permissions. The installer file has a naming format of:
SharePlex-release#-platform.tpm
Change the permissions of the file as follows:
# chmod 555 SharePlex-release#-platform.tpm
SharePlex can be installed unattended through the use of a response file. This installation method speeds the installation of multiple SharePlex instances. The file supplies responses to the standard installer prompts, while providing on screen status information.
Note:When running in unattended mode, the installation process does not call the system password utility. If you create a new SharePlex user during the installation, that user will remain locked until the password is set manually.
Response files that you can edit are located in the install subdirectory of the SharePlex product (installation) directory:
/productdir/install
Important! The response file contains two sections. Only the top section is user configurable. Do not edit the bottom section. The bottom section begins with the line "Do not change settings that appear below."
Edit the top section of the response file to provide the responses for the installation. Only edit the values to the right of the colon, and make certain there is a space between the colon and the response.
The following example is for non-root installation:
# To install SharePlex with the unattended option please
# modify the settings below. You may safely modify only the values
# to the right of the colon, and the colon must be immediately
# followed by a space. Editing the values to the left of the colon
# may impact the unattended install causing the process to become
# interactive.
#
SharePlex Admin group: spadmin
product directory location: /home/splex/proddir
variable data directory location: /home/splex/vardir
# not required for Open Target installations # ORACLE_SID that corresponds to this installation: oracledb
# not required for Open Target installations# ORACLE_HOME directory that corresponds to this ORACLE_SID: /home/oracle/products/version
TCP/IP port number for SharePlex communications: 2100
the License key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
the customer name associated with this license key: SharePlex_Trial
To run the response file
From the command shell of the operating system, run the .tpm installation file with the -r option followed by the full path to the response file.
# ./installation_file -r /users/shareplex/product.rsp
For additional setup requirements, see the Next Steps section in one of the following depending on the platform:
Install SharePlex on Linux/Unix for Oracle Database
Install SharePlex on Linux/Unix for Open Target Databases
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 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.
| Sub-directory | Contents |
|---|---|
| BACKUP | Uninstall information |
| bin | SharePlex executable files |
| config | Internally used content. |
| data | Default parameter settings |
| doc | Catalog of exception messages |
| install | (Unix and Linux only) Scripts related to installation, licensing and upgrades |
| lib | SharePlex shared libraries |
| log | SharePlex log files |
| mks_oe | Runtime installation files for third-party software used by SharePlex. |
| 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. |
| 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.
© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center
