Chat now with support
Chat with Support

SharePlex 8.6.6 - Reference Guide

About this guide Conventions used in this guide SharePlex commands SharePlex parameters SharePlex utilities Appendix B: SharePlex environment variables

Database checklist

Oracle source or target database

Requirement Completed? (Y/N)

Perform any required database upgrades.

Perform any required database upgrades before you install SharePlex. This ensures that SharePlex gets the most current object definitions when you run Database setup during the installation and setup steps.

 

Confirm the Oracle release version and processor type.

(Oracle source and target databases)

  • Verify that the Oracle release version is supported by SharePlex. See the System Requirements in the SharePlex Release Notes for more information.
  • Confirm that the database is a 64-bit version. SharePlex does not support 32-bit Oracle versions.
 

Enable supplemental logging.

(Oracle source databases)

SharePlex requires the minimum level of supplemental logging to be enabled. If you are installing SharePlex in a cluster, enable the logging on all nodes. Some SharePlex features require the logging of primary key values. For more information about configuring Oracle logging, see Set up Oracle redo logging to support SharePlex in the SharePlex Administration Guide.

 

(Recommended) Enable the logging of primary and unique keys.

(Oracle source databases)

To eliminate the need for SharePlex to query the database for key values, it is recommended that you enable supplemental logging of primary and unique keys. Making a query to obtain key values adds overhead that reduces the performance of the Read process.

See the following topics in the SharePlex Administration Guide for additional information:

 

Set privileges to capture TDE-protected data.

(Oracle source databases)

To decrypt TDE-protected data from the redo log, the SharePlex Administrator must open the Oracle Wallet with the wallet password. By default, only the Oracle Wallet owner-user has read and write permissions for this file. To enable SharePlex to open the wallet, you can either of the following:

Grant read permission to the wallet file to the dba group, because the SharePlex Administrator user is a member of that group.

Or...

Have the owner of the wallet start SharePlex.

For more information about configuring SharePlex to support TDE, see Set up TDE Support in the SharePlex Administration Guide.

 

Check the redo log location on ASM

(Oracle source databases)

If the database uses ASM, the Oracle redo logs (online and archive) cannot be located under the ASM root directory.

 

Plan the SharePlex Oracle account.

(Oracle source and target databases)

As part of the installation procedures, you will run the Database Setup (ora_setup) utility to create a database account (user and schema) for SharePlex. The following is a list of privileges required for the database user who runs this program:

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;

 

Plan the SharePlex objects tablespace.

(Oracle source and target databases)

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.

 

Plan the SharePlex temporary tablespace.

(Oracle source and target databases)

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.

 

Plan for the SharePlex index tablespace.

(Oracle source and target databases)

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.

 

Install the Oracle client.

(Oracle source and target databases)

The Oracle client libraries are needed both for installation and setup as well as for the operation of SharePlex.

 

Consider character sets

(Oracle source and target databases)

For SharePlex to replicate all characters within the Oracle character sets that you are using, one of the following must be true:

  • The character sets are identical on the source and target
  • The character set of the source database is a subset of the character set of the target database (all characters contained on the source exist in the character set of the target)

For more information about how character set conversion is handled and how to apply data without conversion, see Set up an Oracle database to support SharePlex in SharePlex Administration Guide.

 

Check the log buffer size.

(Oracle target database)

The number of database writers has an impact on replication, especially when there are numerous concurrent transactions. Whenever a transaction is committed, its buffered data is flushed to disk. If most transactions are small, but the buffer is large, this can cause slow posting. When a large transaction is committed while another, more normal-sized transaction is committed, the second COMMIT must wait while the entire buffer is flushed to disk.

Reducing the size of the buffer that is flushed to disk can speed the Post process. Try decreasing the size of the log buffer to 1024 KB, or even 512 KB if possible.

 

Adjust the SHAREPLEX_TRANS table

(Oracle target database)

SharePlex updates the SHAREPLEX_TRANS table to maintain read consistency for the target database. You might need to adjust the initrans setting of this table to improve replication performance and reduce contention on that table:

  • If the production database has between 500 and 1,000 concurrent users, rebuild the SHAREPLEX_TRANS table to have an initrans of 30.
  • If the production database has more than 1,000 concurrent users, rebuild the SHAREPLEX_TRANS table to have an initrans value of 40.
 

Set the Oracle PROCESSES, SESSIONS, and OPEN_CURSPRS parameters.

(Oracle target database)

For the PROCESSES and SESSIONS parameters, 65 is the minimum value required by the SharePlex Post process so that it can open enough SQL connections to the target database to handle current transaction volume. This value is determined by the default setting of the SP_OPO_THREADS_MAX parameter, plus one for the main Post thread.

SharePlex also requires the value of the Oracle OPEN_CURSORS parameter to be set correctly on the target database.

For more information, see Set up an Oracle database to support SharePlex in the SharePlex Administration Guide.

 

Review requirements for objects in replication.

(Oracle source and target databases)

Review information and guidelines for configuring the following object properties:

  • Keys
  • Indexes
  • Triggers
  • Constraints
  • Sequences

See Set up Oracle database objects for replication in the SharePlex Administration Guide.

 

Open Target databases

Note: The SharePlex-supported Open Target targets are listed in the SharePlex Release Notes. Other targets may be in beta testing. For more information about the SharePlex beta program, see the SharePlex Release Notes.

General checklist items - all Open Target databases

 

Requirement Completed? (Y/N)

Perform any required database upgrades.

Perform any required database upgrades before you install SharePlex. This ensures that SharePlex gets the most current object definitions when you run Database setup during the installation and setup steps.

 

Confirm the database release version.

Verify that the release version of the database is supported by SharePlex. See the System Requirements in the SharePlex Release Notes for more information.

 

Consider character sets

When replicating to an Open Target target (non-Oracle target), SharePlex supports replication from any Oracle Unicode character set and the US7ASCII character set. SharePlex posts data to Open Target in the Unicode character set, and therefore if the source data is Unicode or US7ASCII, no conversion on the target is required.

However, if the following are true, conversion is required on the target:

  • If the character set of the source data is anything other than Oracle Unicode or US7ASCII, you must install an Oracle client on the target to perform the conversion to Unicode for posting to the target.
  • If the data must be posted to the target database in any character set other than Unicode, you must install an Oracle client on the target to perform the conversion and use the target command to identify the target character set for Post to use. See the SharePlex Reference Guide for more information about this command.

To perform conversion with an Oracle client on Linux

  1. Install an Oracle Administrator client on the target system. The client must be the Administrator installation type. The Instant Client and Runtime installation types are not supported.
  2. Set ORACLE_HOME to the client installation. Set ORACLE_SID to an alias or a non-existing SID. SharePlex does not use them and a database does not have to be running.
  3. Download the Oracle-based SharePlex installer, rather than the Open Target installer, to install SharePlex on the target system. The Oracle-based installer includes functionality that directs Post to use the conversion functions from the Oracle client library to convert the data before posting to the target database.
  4. Follow the instructions for SharePlex for Oracle (not the ones for installing on Open Target).
  5. Make certain the SP_OPX_NLS_CONVERSION parameter is set to the default of 1.

To perform conversion with an Oracle client on Windows

  1. Install an Oracle Administrator client on the target system. The client must be the Administrator installation type. The Instant Client and Runtime installation types are not supported.
  2. In the SharePlex Registry key \HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\QuestSoftware\SharePlex\port_number, set ORACLE_HOME to the Oracle client installation location, and set ORACLE_SID to an alias or a non-existing SID. No Oracle database is required. SharePlex only needs to use the client libraries.
  3. SharePlex using the Windows installer.
  4. Make certain the SP_OPX_NLS_CONVERSION parameter is set to the default of 1.

To apply Unicode and US7ASCII data without conversion

If the source data is Unicode or US7ASCII and you are not replicating LOB data, no conversion or Oracle client is needed. Set the SP_OPX_NLS_CONVERSION parameter to 0 to disable conversion, and then restart Post if it is running.

 

Install the appropriate ODBC driver.

Verify that the appropriate ODBC driver is installed for your target, and install one if there is not one present.

For Microsoft SQL Server, make certain to do the following:

Install the Microsoft SQL Server ODBC Driver. It must be that driver, not the Microsoft SQL Server Native Client, or SharePlex will return an error when you run mss_setup to configure Post to connect to the database. To tell the difference between the two drivers:

  • The Microsoft SQL Server ODBC Driver has versions such as 06.02.9200.
  • The Microsoft SQL Server Native Client has versions such as 11.00.3513.

To test a driver with SharePlex you can use the OTS utility. You can use a standalone version of this utility before you install SharePlex, or you can run the utility from the installation directory after you install SharePlex. See the OTS documentation in the SharePlex Reference Guide for more information. NoteSharePlex is already certified to work through ODBC with SQL Server, PostgreSQL, and Sybase targets.

 

Enable case sensitivity on key columns

Enable case-sensitivity for the data of any character-based primary key columns or columns that form a unique index. This ensures that Post compares the correct source and target key values so that it updates the correct target row and prevents unique constraint errors. Unless the key values are case sensitive, cases like the following can happen:

Create table Sales (CustName varchar(20) primary key);

insert into Sales values (‘abc company’);

(Succeeds)

insert into Sales values (‘ABC Company’);

(Fails with unique constraint violation error)

 

Disable triggers on the target tables.

Triggers must be configured to ignore Post operations.

 

To get additional information

Additional post-installation setup steps are required to support Open Target database targets. See the SharePlex Administration Guide for instructions on setting up an Open Target database after you install SharePlex.

 

(SQL Server) Configure a Data Source Name

Create a System (not User) Data Source Name (DSN) for the SQL Server database on the Windows system. The DSN can use either Windows NT authentication or SQL Server authentication. If you configure the DSN to use NT authentication and are using SQL Server 2012 or later, grant the NTAuthority\SYSTEM user the sysadmin fixed server role. ( For earlier versions of SQL Server, sysadmin is granted to the NT Authority\SYSTEM user by default.)

Test connection to the database through this DSN.

 
Related Documents