Chat now with support
Chat with Support

SharePlex 9.2.4 - Installation and Setup for Oracle Source

About this Guide Conventions used in this guide SharePlex pre-installation checklist Download the SharePlex installer Installation and setup for Oracle cluster Installation and setup for remote capture Install SharePlex on Linux and UNIX Install SharePlex on Windows Assign SharePlex users to security groups Set up an Oracle environment for replication Set up replication from Oracle to a different target type Generic SharePlex demonstration-all platforms Advanced SharePlex demonstrations for Oracle Solve Installation Problems Database Setup Utilities General SharePlex Utilities Uninstall SharePlex Advanced installer options Install SharePlex as root Run the installer in unattended mode SharePlex installed items

Uninstall SharePlex from Windows

Files removed by the uninstall program

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):

  • The SharePlex desktop icons.
  • The SharePlex menu items (except for the top-level Program Manager Group folder).
  • The SharePlex product directory. If the variable-data directory is installed under the product directory but contains no files that were added after installation, it is removed as well.
  • The MKS Platform Components software and NuTCRACKER service.

Use the Custom uninstall option to remove specific files while leaving the others intact.

Files not removed by the uninstall program

The uninstall program does not remove the following components.

  • The SharePlex entry in the Registry.
  • Files that already existed in the product directory when the current version of SharePlex was installed.
  • Files created by SharePlex or a user in the product or variable-data directory after the current version of SharePlex was installed. Such files can be removed manually after SharePlex is removed. This is standard procedure for most Windows applications.
  • The SharePlex variable-data directory. To remove this directory, delete it through the operating system. The uninstall program does not remove this directory because there could be user-created files, such as configuration files and custom parameter settings, that you want to keep for a future installation of SharePlex.

Remove SharePlex from the system

Perform these tasks in the order shown.

Remove the SharePlex service

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.

  1. Double-click the SpUtils desktop icon.
  2. Click the SharePlex Services tab.
  3. Select the port number for the SharePlex instance that you want to remove. The Current State field displays the status of SharePlex on that port.
  4. If the service is running, click Stop. Make certain the status shows Stopped.
  5. Click Remove.
  6. Stop and remove other SharePlex services as needed.
  7. Close the SharePlex Services dialog box.

Remove the SharePlex software

  1. 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.

  2. 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.

    • Select Repair to re-install files or update Registry entries. Click Finish to execute the repair.

Remove the MKS Toolkit operating environment

The MKS Platform Components software and NuTCRACKER service (and corresponding Registry entries) are removed when you uninstall SharePlex using the Automatic option.

  1. Remove the MKS Platform Components software using the standard Programs uninstall option in the Windows Control Panel.
  2. Remove the NuTCRACKER service from the Services utility of the Windows Control Panel.

Remove Registry entries

  • The following Registry entries, if they exist, can be removed by a System Administrator after SharePlex is uninstalled.

    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.

    Remove the SharePlex user and database objects

    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.

  • 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:

    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.

    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:

        SharePlex-release#-platform.tpm

      3. Change the permissions of the file as follows:

        # chmod 555 SharePlex-release#-platform.tpm

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

    Run the installer in unattended mode

    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

    Enter responses in the file

    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

    Next Steps

    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

    Related Documents