SharePlex 9.0 - Installation Guide

Set up TDE Support

SharePlex uses the TDE Master Encryption Key to decrypt TDE-protected data that must be replicated. SharePlex uses the Oracle wallet password to access the TDE Master Encryption Key.

If the wallet opens successfully, Capture connects to the decryption module and processes the data. If the wallet does not open, Capture remains in the initialization state until either the wallet is opened or the process is stopped. The initialization state that is displayed in the show capture command is "Capture state: Waiting for open wallet."

Note:  The SharePlex copy/append command does not support TDE. For full information on the Oracle features that SharePlex supports, see the SharePlex Release Notes.

Required privilege to capture TDE-protected data

To decrypt TDE-protected data from the redo log, the SharePlex Administrator must open Oracle Wallet using the wallet password. By default, only the Oracle Wallet owner-user has read and write permissions for this file. You can either start as the owner of the wallet, or you can grant read permission to the file to the dba group, because the SharePlex Administrator user is a member of that group.

Configure SharePlex to capture TDE-protected data

To configure SharePlex to support TDE-protected data, two setup tools must be run:

• (If this was not done during installation) Run Database Setup.When prompted to enable TDE replication, type "y" and then enter the fully qualified path to the TDE wallet file, including the wallet file name, when prompted. For more information, see Database Setup Utilities.
• Run the sp_wallet utility to provide the Oracle Wallet password to SharePlex. This utility can be run in manual or auto-open mode.

To run sp_wallet and manually supply the password

1. On the source system, start SharePlex from the SharePlex product directory. You are prompted to run sp_wallet.

   *** To enable TDE replication, run sp_wallet and provide the wallet password ***

2. Run sp_wallet.

   ./sp_wallet [-r port_number]

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

   ./sp_wallet -r 9400

   wallet password: walletpw

   Wallet loaded into SharePlex

To run sp_wallet in auto-open mode

If you are using an auto-open wallet, you can configure SharePlex to open the TDE wallet automatically. This eliminates the need to run sp_wallet manually at SharePlex startup. The syntax is:

./sp_wallet --auto-open [-r port_number]

Important! Using the auto-open wallet feature has additional security considerations. See the Oracle documentation for more information. In addition, do not back up the SharePlex variable-data directory together with the Oracle wallet and the Oracle data files.

To cancel auto-open mode

./sp_wallet --no-auto-open [-r port_number]

To change the TDE master encryption key

If you need to change the TDE Master Encryption Key while a SharePlex configuration is active, take the following steps to ensure that SharePlex continues to replicate the TDE-protected data after the changes.

1. Quiesce the source database.
2. Make sure that Capture finishes processing the remaining data in the redo log.
3. Shut down SharePlex.
4. Change the TDE Master Encryption Key.
5. Restart SharePlex.

6. Run the sp_wallet utility to provide SharePlex with the new TDE Master Encryption Key.

   ./sp_wallet [-r port_number]

Set up replication between SQL Server databases

Contents

About these instructions

SharePlex can post replicated SQL Server source data to a Microsoft SQL Server target database through an Open Database Connectivity (ODBC) interface. These instructions contain the basic setup steps to take to support this target.

For additional information, see the following:

• For the datatypes and operations that are supported when using SharePlex to replicate from and to a SQL Server database, see System Requirements — SQL Server Capture .
• For additional configuration options, activation steps, and monitoring information, see the SharePlex Administration Guide.
• For reference documentation on SharePlex commands, parameters and utilities, see the SharePlex Reference Guide.

Configure SharePlex on the source

Configure SharePlex and the database on the source system as follows.

Run Database Setup

If you did not run Database Setup for SQL Server during the installation of SharePlex, run the utility now to establish a database account and connection information for SharePlex. See For more information, see Database Setup for SQL Server.

Ensure that all tables have a primary key

To replicate from a source SQL Server database to a target SQL Server database, all SQL Server source tables must have a primary key. This is a requirement of the native SQL Server replication, which is used in part by SharePlex for data capture. See the SQL Server source checklist for more information about these and other pre-configuration requirements for a SQL Server source.

All Oracle targets must have corresponding keys.

Ensure varchar(max) length compatibility

If replicating varchar(max) data to a SQL Server target, make certain that the data size does not exceed 1GB in length. Although SQL Server supports varchar(max) data of up to 2 GB in length, the Windows ODBC driver supports VARCHAR(max) data of up to 1 GB in length. Sample ODBC error message, which is included in the Post error message: [ODBC SQL Server Driver]Invalid precision value.

Configure replication

To configure replication from a SQL Server source to a SQL Server target, use the following syntax in the configuration file on the source system.

Note: See Configure SharePlex to replicate data in the SharePlex Administration Guide for additional information about creating a configuration file.

where:

Important!

• If a database is case-sensitive, enclose the case-sensitive object names in quotes.
• If the letter case of the column names on the source is different from the letter case of the target columns, for example the source is all capitals while the target is lower case, use the column mapping feature to map the column names in the configuration file. For more information, see Map source and target columns in the SharePlex Administration Guide.

Source configuration example

The following configuration file replicates table HR.EMP from the source to target table Region1.Emp on target system. The target table is case-sensitive.

Configure SharePlex on the target

If you did not run Database Setup for SQL Server during the installation of SharePlex, run the utility now to establish a database account and connection information for SharePlex. For more information, see Database Setup for SQL Server.

Set up replication between different database types

Contents

About these instructions

This chapter contains instructions for configuring SharePlex to replicate from one type of data store (currently capture from relational databases) to another, for example Oracle to PostgreSQL, from Oracle to a file-type data store, and from SQL Server to Oracle. This is known as heterogeneous replication.

These instructions highlight specific tasks that are pertinent to a data flow between source and target. Refer to other topics in the SharePlex documentation as needed to complete the configuration, deploy any optional features that apply, and monitor and maintain the environment.

For additional information, see:

• For the SharePlex-supported data stores, datatypes and operations that are supported by SharePlex, see the system requirements, starting with the Basic system requirements.
• For additional configuration options, activation steps, and monitoring information, see the SharePlex Administration Guide.
• For reference documentation on SharePlex commands, parameters and utilities, see the SharePlex Reference Guide.

Set up replication from Oracle to MySQL

Overview

SharePlex can post replicated Oracle data to a MySQL or Aurora target database through an Open Database Connectivity (ODBC) interface.

These instructions contain setup instructions that are specific to this target. Install SharePlex on the source and target according to the appropriate directions in this manual before performing these setup steps.

For the versions, datatypes and operations that are supported when using SharePlex to replicate to this target, see the SharePlex Release Notes.

Install SharePlex

Important! If replicating to MySQL or Aurora on a PaaS cloud server (no access to the operating system), see the installation instructions in Installation and setup for cloud-hosted databases

Review column names

To support replication between a source of one database type and a target of another type, the letter case of the names of the source and target columns must be the same, for example the column names on both sides in lower case or both sides in upper case. If the case differs between the source and target column names, use the column mapping feature to map the column names in the configuration file.

See the SharePlex Administration Guide for more information about column mapping with SharePlex.

Configure SharePlex on the source

Set up SharePlex and the database on the Oracle source system as follows.

Make keys available to SharePlex

To replicate from an Oracle source to an Open Target target, you must make key information available to SharePlex.

Enable Oracle supplemental logging

Enable PK/UK supplemental logging in the Oracle source database. SharePlex must have the Oracle key information to build an appropriate key on the target.

Set SP_OCT_USE_SUPP_KEYS parameter

Set the SP_OCT_USE_SUPP_KEYS parameter to a value of 1. This parameter directs SharePlex to use the columns set by Oracle's supplemental logging as the key columns when a row is updated or deleted. When both supplemental logging and this parameter are set, it ensures that SharePlex can always build a key and that the SharePlex key will match the Oracle key.

See the SharePlex Reference Guide for more information about this parameter.

Configure replication

On the source, create a SharePlex configuration file that specifies capture and routing information.

where:

* Important! 

If target owner or table name is defined in the database as anything other than UPPERCASE, be certain to:

• Type the name in the correct case.
• Enclose the name in quotation marks, for example "MySchema"."MyTable".

• To support replication between a source of one database type and a target of another type, the letter case of the names of the source and target columns must be the same, for example the column names on both sides in lower case or both sides in upper case. If the case differs between the source and target column names, use the column mapping feature to map the column names in the configuration file.

Note: This is a basic one-source, one-target configuration using no additional SharePlex configuration features. See Configure SharePlex to replicate data in the SharePlex Administration Guide for important information about creating a configuration file and for additional setup instructions for more complex replication scenarios.

Source configuration example

The following configuration file replicates table HR.Emp from Oracle instance ora112 to target table region1.emp in database mydb on target system sysprod. The source table is case-sensitive.

Configure SharePlex on the target

1. Make certain that the database setup meets all of the requirements in Open Target checklist .

2. Run Database Setup for MySQL (mysql_setup) to establish a database account and connection information for SharePlex. For more information, see Database Setup for MySQL.