Chat now with support
Chat with Support

SharePlex 9.0.1 - Installation Guide

About this Guide Conventions used in this guide System Requirements SharePlex pre-installation checklist Installation and setup for Oracle cluster Installation and setup for cloud-hosted databases Download SharePlex 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 between SQL Server databases Set up replication between different database types Basic SharePlex demonstrations Advanced SharePlex demonstrations Solve Installation Problems Uninstall SharePlex SharePlex Utilities 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.

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 and MKS Toolkit entries 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.
  • The MKS Components programs and files. These can be removed separately using the Remove the MKS Toolkit operating environment procedure.

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

Changing and removing Windows Registry components may be harmful to the system. Contact your System Administrator for assistance if needed.

  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 exist and can be removed by a System Administrator.

    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432\Node\Datafocus

    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432\Node\Mortice Kern Systems

    HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432\Node\Quest Software

    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.

    Important! If you intend to reinstall SharePlex or MKS Toolkit, they will not reinstall unless these Registry entries are removed.

  • SharePlex Utilities

    Contents

    Add a SharePlex license key

    Description

    Use the SharePlex license utilities to view and add license keys to hosts in the SharePlex replication environment. Each installation of SharePlex requires a valid license key. There are three types of SharePlex license keys:

    • Temporary license keys (demonstration licenses)
    • Permanent license keys
    • Site license keys

    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.

    If you do not have a valid license key, you may obtain one from Quest Technical Support or your Quest sales representative. Use the appropriate procedure in this documentation to obtain the necessary information to support your license request.

    License utilities on Unix and Linux

    On Unix and Linux systems, separate utilities are used to:

    Gather information to request a license

    Use the splex_uname utility to collect information about the local host that is required for Quest to generate a license key. Run this utility from the util sub-directory of the SharePlex product directory.

    $ /proddir/util/splex_uname

    The information is similar to the following example:

    Local system info:
    Host Name	 	= irvspxu09
    Host ID	 	= 2198894273 (831076C1 HEX)
    Operating System	= SunOS
    Machine model		= SUNW,UltraAX-i2
    CPU Type		= sparc9
    CPU Speed	 	= 500
    Number of CPUs	 	= 1

    Add a license key

    Use the splex_add_key utility to add a license key to a machine during the installation of SharePlex or afterward to convert from one type of license to another.

    You can use the splex_add_key utility as follows:

    • You can use splex_add_key on the primary node of a cluster to install licenses for all secondary nodes in the cluster, because they all share one variable-data directory.
    • You cannot use splex_add_key to add licenses for non-clustered machines from one machine. It must be run on each non-clustered replication system so that the license information is stored in the variable-data directory on each system.

    To run splex_add_key

    1. Log on to the system as the SharePlex Administrator.
    2. Run sp_ctrl on the machine where you want to install a license key.
    3. If SharePlex is running, shut it down.

      sp_ctrl> shutdown

    4. Run splex_add_key from the install sub-directory of the SharePlex product directory.

      $ /proddir/install/splex_add_key

    5. Choose the appropriate option for how to install the key:

      SharePlex License Utility
      1) Read license key from file
      2) Enter license key manually
      3) Add license key for alternate host
      q) Quit License Utility
      Enter option:

      Note: Use option 3 when installing on secondary nodes in a cluster. To install SharePlex in a cluster, see Installation and setup for Oracle cluster .

    6. If you are entering the key manually, type the license key exactly as you received it from Quest, including the SPLEXKEY= string if one prepends the key, any spaces, and any capitalization. Press Enter when finished typing the key.

    7. Enter the SiteMessage text string provided by Quest with the license key.

      Note: If you selected option 3 to install in a cluster, the utility continually prompts for another machine ID to license, until you exit the license utility.

    8. Enter q to exit the utility.
    9. Start SharePlex when you are ready for replication to resume.

    View a license key

    Use the splex_get_key utility to view the SharePlex license key, license type, and expiration date on a machine. Run this utility from the install sub-directory of the SharePlex product directory.

    $ /proddir/install/splex_get_key

    The information is similar to the following example:

    $ /splex/proddir/install/splex_get_key
    Customer Name = Quest
    License Key = EANLCF3P56F8M1JB1K6RBJCBB6TBEP0
    Product Name = SharePlex Oracle
    License type = demo key
    Expired on = 01/01/2008 12:00 AM

    License utility on Windows

    On Windows platforms, all licensing functions are performed through the SpUtils utility, including viewing the machine ID for a system. Launch the SpUtils utility from the shortcut on the Windows desktop.

    Gather information to request a license

    Select the Information tab to view information about the local host that is required for Quest to generate a license key. In a cluster, run SpUtils on each node.

    Add a license key

    Use SpUtils to add a license key to a machine during the installation of SharePlex or afterward to convert from one type of license to another. In a cluster, run SpUtils on the primary node.

    1. Log on to Windows as the SharePlex Administrator.
    2. If SharePlex is running, do the following:

      1. Select the SharePlex Services tab.
      2. Select the port number of the SharePlex instance for which you want to add a license key.
      3. Click Stop.
      4. Wait for Current State to display a message that the service stopped.
    3. Select the License Keys tab.
    4. Select the SharePlex port number from the Port list.

    5. Click Add License, then type or paste the information exactly as you received it from Quest, as follows:

      1. License Key: The license key, including any spaces. The key is case-sensitive.
      2. Customer Name: The text string that was included with the license. The name is case-sensitive.
    6. (Windows Cluster) To add a license for another node in a cluster, select the Add Alternate Host Id check box, then select the machine ID from the CPU ID list box. Repeat this step to add a license to all secondary nodes in the cluster.

    7. Click OK to close the utility.

    8. To start SharePlex, do the following:

      1. Select the SharePlex Services tab.
      2. Select the port number of the SharePlex instance that you licensed.
      3. Click Start.
      4. Wait for Current State to display a message that the service started.

    View a license key

    Select the License Key tab, then select the port number (if running multiple SharePlex instances) for which you want to view license information.

    • Under License Key, view the actual license key and SiteMessage text string.
    • Under Status, view the type of SharePlex installation, the license type, and the expiration date.

    In a cluster, run SpUtils on each node to view the local license.

    Install the SharePlex service

    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

    1. Run the SpUtils utility from the SharePlex entry in the Programs menu.
    2. Select the Service tab.
    3. Select the SharePlex port number for which you are installing the service.
    4. Click Install. (A "Service Stopped" message indicates that the service is installed.)
    5. (Optional) Click Start to start the 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.

    Related Documents

    The document was helpful.

    Select Rating

    I easily found the information I needed.

    Select Rating