Chat now with support
Chat with Support

SharePlex 9.0.2 - Preinstallation Checklist

Database Setup for Oracle


Use the Database Setup utility for Oracle (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 this utility at the time of SharePlex installation depends on whether the database is a source, intermediary, or target database, 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 the Database Setup utility 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 the Database Setup utility during SharePlex installation.
  • If you intend to use a hot backup to establish the target data, do not run the Database Setup utility. You will run it when you perform the initial synchronization procedure.

    Note: If you run the Database Setup utility 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

The setup utility 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.

    Privileges granted to SharePlex

  • The Database Setup utility 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 toSharePlexUser;

      • To replicate DDL:

        grant select any table toSharePlexUserwith admin option;

        grant create any view toSharePlexUserwith admin option;


    • 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 the Database Setup utility for all source and target Oracle instances in the SharePlex replication configuration.
    • Within a cluster, run the Database Setup utility 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 the Database Setup utility 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.

    • If the Oracle database is a multitenant container database, run the Database Setup utility for each pluggable database involved in a replication scenario. A SharePlex user and schema objects must exist in each PDB.
    • If you run the Database Setup utility when there is an active configuration, the DDL that the 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 the utility, then return the parameter to its previous setting after the setup is complete. This parameter takes effect immediately.

    SharePlex schema storage requirements

    The Database Setup utility for Oracle 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 Database 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.

    Preferred action: If you enable supplemental logging for primary and unique keys, you can set the SP_OCT_ENABLE_LOBMAP parameter to 0, and nothing will be stored in the SHAREPLEX_LOBMAP table. In this case, you do not have to consider its size growth. It is recommended that you enable supplemental logging for primary and unique keys to maximize the performance of the Read process.

    Alternate action: 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 Database 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.

    SharePlex index tablespace

    The Database 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.

    Required run privileges

    The user who runs the Database Setup utility must have the following privileges:

    Amazon RDS target

    The user who runs the setup utility must be the master user that was created when the RDS instance was created. This user is granted the required DBA privileges automatically.

    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 Database Setup for Oracle

    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 Database 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 4: 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: Type N to use a tns_alias if the database is a multitenant database, if the database is a target on Amazon RDS, 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 a global alias.

    Multitenant database: Specify the tns_alias of the PDB.

    Amazon RDS: (SharePlex is installed on a non-cloud server) Specify the alias of the RDS database.

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


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

    Enter Y or 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

    The document was helpful.

    Select Rating

    I easily found the information I needed.

    Select Rating