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

SharePlex Utilities

SharePlex utilities
Contents

Add a SharePlex license key

SharePlex Utilities > 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 install sub-directory of the SharePlex product directory.

$ /proddir/install/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 in a 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 Site Message 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 Utilities > 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.

Oracle Setup (ora_setup)

SharePlex Utilities > Oracle Setup (ora_setup)

Overview

Use the Oracle Setup utility (ora_setup) to establish SharePlex as an Oracle user and create the required SharePlex database objects. This setup utility creates the following:

  • A SharePlex account
  • Tables and indexes for use by SharePlex and owned by the SharePlex account
  • Default connection for the SharePlex user

It is recommended that you review all of the content in this topic before running the setup utility.

Supported databases

Oracle on supported platforms

When to run Oracle Setup

Whether or not to run Oracle Setup at the time of SharePlex installation depends on whether this is a source, intermediary, or target system and on how you intend to synchronize the data. To view the initial synchronization procedures, see the SharePlex Administration Guide.

System Type When to run Oracle Setup

Source system

During installation of SharePlex

Intermediary system An intermediary system is used in a cascading configuration, where SharePlex replicates data to a remote system (or systems) and then sends that data from the intermediary system to the final target. If you intend to configure SharePlex to post data to a database on an intermediary system, and you intend to use a hot backup to establish the data on that system and the target, do not run Oracle Setup on the intermediary or target systems. You will run it when you perform the initial synchronization procedure.

Target system

Depends on the method that you will use to synchronize the source and target data when you are ready to activate replication:

  • If you intend to use transportable tablespaces or a cold copy (such as export/import, store/restore from tape, FTP), run Oracle Setup during SharePlex installation.
  • If you intend to use a hot backup to establish the target data, do not run Oracle Setup. You will run it when you perform the initial synchronization procedure.

    Note: If you run Oracle Setup before the backup and recovery, the setup gets overwritten, and you will need to re-run it again after the backup and recovery.

Supported Oracle Connections

Oracle Setup can configure any of the following connections for the SharePlex user to use when connecting to the database.

Database type Connection
Database with or without ASM Bequeath

Database with or without ASM

TNS alias

  • (A TNS login is specified for both the database and the ASM instance.)
  • PDB with ASM

    TNS alias for the PDB and either TNS or bequeath for the ASM instance.

    Requirements for using Oracle Setup

    • Install the database client on the system where you are running Oracle Setup. Consult the Oracle documentation for the appropriate client version to use with the database.
    • Run Oracle Setup for all source and target Oracle instances in the SharePlex replication configuration.
    • Within a cluster, run Oracle Setup on all nodes of the cluster. This ensures that the SharePlex settings in the Windows Registry include the correct ORACLE_SID.
    • For a consolidated replication topography, or other topology with multiple variable-data directories, run Oracle Setup for each variable-data directory.
    • SharePlex supports local BEQUEATH connections or remote connections using a TNS alias. Be prepared to supply Oracle Setup the needed connection values for whichever connection you want to use. Review Run Oracle Setup to familiarize yourself with the prompts before you actually run Oracle Setup.

    • If the Oracle database is a multitenant container database, run Oracle Setup for each pluggable database involved in a replication scenario. A SharePlex user and schema objects must exist in each PDB.
    • If you run Oracle Setup when there is an active configuration, the DDL that Oracle Setup performs to install or update the SharePlex internal tables will be replicated to the target. To work around this issue, set the SP_OCT_REPLICATE_ALL_DDL parameter to 0 before running Oracle Setup, then return it to its previous setting after Oracle Setup is complete. This parameter takes effect immediately.

    SharePlex schema storage requirements

    Oracle Setup installs some database objects for use by SharePlex. The storage requirements for these objects should be satisfied before running Oracle Setup. See the following table.

    Storage Description
    SharePlex objects tablespace

    The setup utility installs some tables into a tablespace of your choosing. All but the SHAREPLEX_LOBMAP table use the default storage settings of the tablespace.

    The SHAREPLEX_LOBMAP table contains entries for LOBs stored out-of-row. It is created with a 1 MB INITIAL extent, 1 MB NEXT extent, and PCTINCREASE of 10. The MAXEXTENTS is 120, allowing the table to grow to 120 MB.

    The default storage usually is sufficient for SHAREPLEX_LOBMAP, permitting more than 4 million LOB entries. If the Oracle tables to be replicated have numerous LOB columns that are inserted or updated frequently, consider increasing the size the SharePlex tablespace accordingly. Take into account that this table shares the tablespace with other SharePlex tables.

    If the database uses the cost-based optimizer (CBO) and the tables that SharePlex processes include numerous LOBs, incorporate the SHAREPLEX_LOBMAP table into the analysis schedule.

    Note: A new installation of SharePlex does not change storage parameters from a previous installation.

    SharePlex temporary tablespace

    The setup utility prompts for a temporary tablespace for SharePlex to use for sorts and other operations, including sorts performed by the compare commands. The default temporary tablespace is the one where the SharePlex objects are installed. If you plan to use the compare commands to compare large tables, especially those without a primary or unique key, specify a dedicated temporary tablespace for SharePlex. For more information about the compare command, see the SharePlex Reference Guide.

    SharePlex index tablespace

    The setup utility prompts for a tablespace to store the indexes for the SharePlex tables. The default index tablespace is the one where the SharePlex objects are installed. To minimize I/O contention, specify a different index tablespace from the one where the tables are installed.

    Note: If indexes from a previous version of SharePlex are installed in the SharePlex objects tablespace, you can move them to a different tablespace and then specify that tablespace when you run the setup utility.

    Privileges granted to the SharePlex database user

  • Oracle Setup grants to the SharePlex database user the following:
    • DBA role and unlimited resource privileges, tablespace privileges, and read privileges to the redo logs.
    • Default Oracle profile. By default this profile has the unlimited resource privileges originally assigned by Oracle. If the default has been changed, assign SharePlex a DBA profile with unlimited resource privileges.
    • The following grants:
      • To access the data dictionary (outside the DBA roles) if O7_DICTIONARY_ACCESSIBILITY is set to FALSE:

        grant select any dictionary to SharePlexUser;

      • To replicate DDL:

        grant select any table to SharePlexUser with admin option;

        grant create any view to SharePlexUser with admin option;

    Required privileges to run Oracle Setup

    The user who runs Oracle Setup must have the following privileges:

    Non-multitenant (standard) database

    The user who runs the setup utility must have DBA privileges, but if support for TDE is required, then this user must have SYSDBA privileges.

    Multitenant database

    The user who runs the setup utility should have SYSDBA privileges (recommended), but at minimum the user should be a DBA user with privileges for sys.users$ and sys.enc$. The minimum following grants are required for the SharePlex user:

    create user c##sp_admin identified by sp_admin;

    grant dba to c##sp_admin container=ALL;

    grant select on sys.user$ to c##sp_admin with grant option container=ALL;

    If TDE support is required for the CDB, then the following additional priviledge is required:

    grant select on sys.enc$ to c##sp_admin with grant option container=ALL;

    Run Oracle Setup

    Important! The Oracle instance must be open before this procedure is performed.

    1. (Unix and Linux only) If you are using multiple variable-data directories, export the environment variable that points to the variable-data directory for the SharePlex instance for which you are running Database Setup.

      ksh shell:

      export SP_SYS_VARDIR=/full_path_of_variable-data_directory

      csh shell:

      setenv SP_SYS_VARDIR /full_path_of_variable-data_directory

    2. Shut down any SharePlex processes that are running, including sp_cop.
    3. Run the ora_setup program from the command prompt of the operating system, using the full path from the SharePlex bin subdirectory.

      Important! On Windows, if you installed SharePlex on any port other than the default of 2100, use the -p option to specify the port number. For example, in the following command the port number is 9400:

      C:\users\splex\bin>ora_setup -p9400

    4. Specify whether the system is a source system, a target system, or both a source and target system in the SharePlex configuration.

      Note: This prompt only appears the first time that you run setup for this database.

    5. For connection type, select Oracle.
    6. Refer to the following table for the prompts and responses to configure SharePlex correctly for the desired connection type, either local using BEQUEATH or remote using a TNS alias.

    Table 1: Database setup prompts and response

    Prompt Response
    Will SharePlex install be using a BEQUEATH connection? (Entering 'n' implies a SQL*net connection):

    Press Enter to use a local BEQUEATH connection, or type N to use a TNS alias connection.

    Note: You must type N to use a tns_alias if the database is a multitenant database or if using SharePlex in a cluster (such as Oracle RAC).

    (If BEQUEATH= Y)

    Enter the Oracle SID for which SharePlex should be installed:

     

    (If BEQUEATH = N)

    Enter the TNS alias for which SharePlex should be installed:

    Non-multitenant database: Accept the default or type the correct SID or TNS alias. On RAC, the tns_alias must be the global alias that you created in Configure SharePlex in an Oracle cluster.

    Multitenant database: Specify the tns_alias of the PDB.

    Enter a DBA user for SID

    Non-multitenant database: Type the name of a database user that has DBA privileges.

    Multitenant database: Type the name of a common user who has the required privileges to install the account and objects.

    Enter password for the DBA account, which will not echo:

    Non-multitenant database: Type the password of the DBA user.

    Multitenant database: Type the password of the common user. Omit the @ and the rest of the connect string. SharePlex constructs the connect string in the proper format.

    Current SharePlex user is user.

    Would you like to create a new SharePlex user?

    Enter N to update an existing SharePlex account or Y to create a new SharePlex account. Enter the credentials when prompted.

    You are allowed five attempts to enter a valid password for an existing SharePlex user. Passwords are obfuscated.

    Important!If there is an active configuration and you changed the SharePlex schema, copy the SharePlex objects from the old schema to the new one to preserve the replication environment.

    Do you want to enable replication of tables with TDE?

    Note: If this is an upgrade and you already have TDE enabled, the following prompt appears before this prompt:

    Formerly, SharePlex required a Shared Secret key. Now, the pathname of the TDE wallet is required.

    Enter Y to be prompted for the path name of the TDE wallet file. Supply the fully qualified path for the TDE wallet file, including the wallet file name.

    Or...

    Press Enter if not replicating TDE tables.

    Enter the default tablespace for use by SharePlex:

    Press Enter to accept the default or type the name of a different tablespace.

    Enter the temporary tablespace for use by Shareplex:

    Press Enter to accept the default or type the name of a different tablespace.

    Enter the index tablespace for use by SharePlex:

    Press Enter to accept the default or type the name of a different tablespace.

    Will the current setup for sid: SID be used as a source (including cases as source for failover or master-master setups)?

    Press Enter if this is a source system or type N if this is a target system. Important: All systems in a master-master configuration (peer-to-peer) and in a high-availability configuration are considered to be source systems due to the bidirectional nature of the replication.

    Note: The rest of the prompts configure an ASM connection. If ASM is not detected, the database setup is complete at this point.

     

    ASM detected. Do you wish to connect to ASM using BEQUEATH connection?

    Press Enter for SharePlex to use a BEQUEATH connection to connect to the ASM instance, or press N to use a TNS alias.

    Important! If the database uses ASM and the database tns_alias is configured with a SCAN IP, then you must specify connection through an ASM tns_alias in order for SharePlex to connect to the ASM instance.

    Do you wish to keep connecting using the same user/password?

    If you selected BEQUEATH, this prompt is displayed. Enter Y to use the same user and password as the login user, or enter N to be prompted for a different user and password.

    Note: If you selected to use a BEQUEATH connection, the database setup is complete. See Note about the tns_alias file:

    If you selected N, the prompts continue.

     

    Enter the ASM tns alias to be used by SharePlex:

    Type the name of the TNS alias.

    Enter an ASM admin (has both sysdba and sysasm privilege) username for alias:

    Type the name of a user with sysasm and sysdba privileges to the ASM instance.

    Enter user password for user:

    Type the password of the user.

    Note: If SharePlex will be reading online redo logs on a remote system, make certain to set the SP_OCT_ASM_USE_OCI parameter to a value of 1:

    After you start sp_cop, and before activating a configuration file, run this command in sp_ctrl:

    sp_ctrl>set param SP_OCT_ASM_USE_OCI 1

    If this is an upgrade and you disabled DDL replication, you can enable it again with the following command in sp_ctrl:

    sp_ctrl> set param SP_OCT_REPLICATE_ALL_DDL 1

    Note about the tns_alias file:

    When you set up SharePlex for database connection through a tns_alias and ASM connection locally through a BEQUEATH connection (through OS authentication), it is important to set up the tns_alias file correctly on each node. Assuming a SharePlex database account exists on the primary node, SharePlex will always connect to the primary ASM_SID automatically because it was provided when SharePlex was installed. However, upon failover, SharePlex must query the local v$asm_client view to get the correct ASM_SID of the failover instance. Therefore, ensure that the IP address of a given node is always listed first in the local tns_names file on that node.

  • Related Documents