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

Unix/Linux system checklist

SharePlex pre-installation checklist > Unix/Linux system checklist
Requirement Completed? (Y/N)

Confirm that the platform is supported.

See the SharePlex Release Notes for supported operating system platforms.

 

Allocate at least 4 GB of memory for SharePlex processes.

Plan for per-process memory up to 256 MB. This recommendation enables the Post and Read processes to allocate larger sets of memory when necessary.

 

Disable the disk cache option.

(Source system) Place the redo logs, archive logs, and SharePlex files on a file system that does not have a cache option. Disk caching may interfere with the capture process. For more information, see the SharePlex Knowledge Base article 30895.

 

Set the number of semaphores per process.

Semaphores help ensure the stability of the SharePlex processes. The required SharePlex settings depend on the platform, as follows:

HP-UX:

  • semmnu: 255
  • shmmax: 60 MB

Oracle Solaris:

  • semmni: 70
  • semmns: 255
  • semmnu: 255
  • semmsl: 128
  • semume: 255
  • shmmax: 60 MB
  • shmmni: 100

Red Hat Linux:

  • semmni*: 70
  • semmns*: 255
  • semmnu: 255
  • semmsl: 128
  • semopm: 64
  • semume: 255
  • shmmax: 60 MB
  • shmmin: 1MB
  • shmmni: 100
  • shmseg: 26

    *These are additive. Add the Oracle minimum values to the SharePlex minimum values to determine the correct setting.

An alternative is to set the value to the number of queues you will be using plus 2. For more information about SharePlex queues, see the SharePlex Administrator Guide.

 

Set the ulimit (number of system file descriptors) to as close to 1024 as possible.

The ulimit can be set either as a system hard limit or a session-based soft limit, as follows:

  • Set a hard limit: (Recommended) A root user and system restart are required to change the hard limit, but the value remains fixed at the correct level to support SharePlex. Consult your System Administrator for assistance.
  • Set a soft limit: A soft limit setting stays in effect only for the duration of the sp_cop session for which it was set, and then it reverts back to a default value that may be lower than the hard limit and too low for SharePlex.
 

Set core file parameters.

  • Set the system core dump block size as large as system resources can accommodate, at minimum 1.5 million blocks. The default is usually 0. Core files help Quest support representatives resolve SharePlex support cases. Higher size settings ensure that enough data is captured to be useful.
  • Set the core file output location to the dump sub-directory of the SharePlex variable-data directory.
  • Set the naming convention of core files to either core or core.pid. Note: SharePlex renames all core files named core to core.pid, except for those generated by sp_cop.

If these requirements are not met, the SharePlex event log might report that a core file was not generated, even though a file exists.

 

Install the ksh shell.

Install the ksh shell before you install SharePlex. The SharePlex monitoring scripts and other features required this shell.

A version of ksh called pdksh is included with the Red Hat Linux builds. Refer to the Red Hat Linux documentation for more information.

 

Install Native POSIX Threading Library (NPTL)

Quest recommends using the Native POSIX Threading Library (NPTL) on Linux. NPTL is faster and behaves more like other Unix operating systems than LinuxThreads. Although LinuxThreads can be enabled per process by using the LD_ASSUME_KERNEL environment variable, setting that variable adversely affects the performance of SharePlex. If LD_ASSUME_KERNEL is employed, use a setting of 2.4.21.

 

Set the UNIX account that installs SharePlex to -rwsr-s--x using set-user-id.

The value of -rwsr-s--x enables the database setup utility (ora_setup) to connect to an Oracle database through SQL*Plus to install the SharePlex database account and objects that supports replication. The UNIX account that installs SharePlex owns this program. The program is located in the bin subdirectory of the SharePlex installation directory.

 

(Debian Linux)

Create a symbolic link to the /lib64/libc.so.6 library path.

On Debian Linux, the /libc.so.6 library files are not in the /lib64/libc.so.6 location that SharePlex expects. Before installing SharePlex on Debian Linux, create a symbolic link to /lib64/libc.so.6.

 

(Oracle Database) Configure the oratab file.

Make sure that the correct ORACLE_SID and ORACLE_HOME values are explicitly listed in the oratab file. SharePlex refers to this file to set its environment.

On Sun machines, SharePlex only uses the oratab file that is in the /var/opt/oracle directory. If there is a copy of the oratab file in the /etc directory ensure that this file is identical to the one in the /var/opt/oracle directory.

 

Windows system checklist

SharePlex pre-installation checklist > Windows system checklist
Requirement Completed? (Y/N)

Confirm that the Windows version is supported.

See the SharePlex Release Notes for supported Windows versions.

 

Address FAT security issues.

The SharePlex user groups determine who can control the SharePlex processes. These groups only function as designed on an NTFS partition. A FAT partition lacks file security, and any user who logs onto a FAT partition has full control of SharePlex.

If SharePlex must be installed on a FAT partition, allow the SharePlex admin group to log in locally, and allow the spopr and spview groups to log in remotely only. Remote logins to a FAT partition preserve group assignments. For more information about SharePlex security groups, see Assign SharePlex users to security groups.

 

Be prepared to restart the system.

On the Windows platform, SharePlex installs the MKS Toolkit® operating environment from Parametric Technology Corporation (PTC). The default folder for the MKS Toolkit® is C:\Program Files\MKS Toolkit.

Set system permissions so that the MKS Toolkit files cannot be moved or removed after they are installed.

For more information about the MKS Toolkit, see Appendix C: SharePlex installed items. If this is a first-time MKS Toolkit installation, you will be prompted to restart the system.

Some restarts are required after installation.

 

Adjust the page size.

SharePlex needs an additional 200 MB of page file size if more than 80 percent of the current total page file size is being used. Greater page size enables SharePlex to process large transactions more quickly.

 

Assign a user who will own the SharePlex directories.

Assign a member of the Windows Administrator group to own the SharePlex installation and variable-data directories. This user must exist before you run the SharePlex installer and must have system privileges to read the Oracle redo logs.

 

(Oracle Database) Verify the Oracle Registry entries.

(Test machines only) On machines where Oracle has been installed and uninstalled many times, the Oracle entries in the Registry may be corrupted. Before you install SharePlex on a test machine, uninstall all Oracle software and delete all Oracle Registry entries. Then, re-install Oracle by using the Oracle installation program, which creates Registry entries correctly. SharePlex relies on these entries to obtain database environment information.

 

(Oracle Database) Set ORACLE_HOME as the first entry in the PATH variable.

SharePlex expects the path to the Oracle binaries to be the first entry in the Windows PATH system variable. Change the variable, if needed, and verify that the path is correct.

 

Oracle Database Checklist

SharePlex pre-installation checklist > Oracle Database Checklist
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)

During SharePlex installation, you will run a database setup utility named ora_setup to create a database account (user and schema) for SharePlex. The following is a list of privileges required for the database user who runs the this utility:

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. For more information about the compare command, see the SharePlex Reference Guide.

 

Plan for theSharePlexindex 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 Checklist

SharePlex pre-installation checklist > Open Target Checklist

Note: The SharePlex-supported Open Target targets are listed in the SharePlex Release Notes.

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 installing 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. Install 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 System 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