SharePlex 10.2.1 - Upgrade Guide for Oracle Source

About this Guide

This guide contains instructions for upgrading SharePlex environment. It is intended for administrators, consultants, analysts, and any other IT professionals tasked with upgrading SharePlex™.

Other SharePlex documentation

For the complete SharePlex documentation set, go to https://support.quest.com/shareplex/technical-documents.

View this document in PDF format

You can download, view and save this document in Adobe PDF format. Click Download in the upper right-hand corner of this page. This action downloads the entire publication.

Before you upgrade

This section contains important information that you need to know before you select a SharePlex installer and begin the upgrade procedure.

Gather the required information

You will need the following information about the installation that you want to upgrade:

• Location of the SharePlex product directory
• Location of the SharePlex variable-data directory (or directories) in this instance of SharePlex.
• Name of the SharePlex administrator group (that contains the SharePlex administrator user).
• The ORACLE_SID and ORACLE_HOME (Oracle) or the database name (Open Target) associated with the installation you are upgrading. To determine this, look in the default.yaml file in the data sub-directory of the product directory.

Check interoperability

If you are upgrading some SharePlex installations in a configuration, but not others, view the SharePlex Release Notes for interoperability support between versions. Parameter settings may be required.

Who should perform the upgrade

Some steps in the upgrade procedures require the Administrator authorization level, which normally is only granted to the person or persons designated as the SharePlex Administrators. An upgrade can only be performed by a person who has this authorization and is familiar with SharePlex.

Check for new and deprecated parameters

• Review the release notes and Deprecated Parameters section of the SharePlex Reference Guide to determine if any of the parameters that you are using were deprecated in this release. SharePlex retains backward compatibility of your current parameter settings, including those that are newly deprecated, so that you do not need to stop processes to reconfigure settings. However, you should familiarize yourself with the new parameter or default functionality that replaces a deprecated parameter to determine whether any configuration changes are appropriate.
• Review the New Features in this Release and Enhancements in this release sections of the Release Notes for any new parameters that affect your current configuration. If any upgrade steps are required, they will be noted.

Upgrade on an Oracle source system

These requirements apply to SharePlex when it captures from an Oracle source database.

Requirements to support character set conversion

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.
• If you are replicating LOB data, conversion is required regardless of what the source character set is.

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

Download the SharePlex installer

There are different installers for SharePlex based on the type of operating system. This topic helps you understand the differences and the naming conventions used.

Windows

On Windows, the SharePlex installer is named sp_setup_version.exe. It is a bundle that contains SharePlex binaries for all of the supported databases and versions.

The installer installs the following items:

• The SharePlex binaries and files
• The SharePlex for database program
• The MKS Platform Components program from Parametric Technology Corporation (default C:\Program Files\MKS Toolkit)
• Windows registry entries under \HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432node.
• One or more SharePlex port_number Windows services (depending on the installed configuration)

Do not remove or modify any of these components while SharePlex is in production, including SharePlex Installer. These components all support SharePlex operation or upgrade.

Where to get SharePlex installers

Download the SharePlex installation package that matches the operating system you are using.

Additionally, download any SharePlex patches, so that you can install them after you install the base software.

1. Go to the Quest Software Support page: http://support.quest.com/

2. Click Download Software.

3. In the search box, type SharePlex and press Go.

4. Click the arrow in the Download column for the version you need. You can also click the file name for access to more information and to download the file(s).

5. Transfer the file to system where you are installing SharePlex.

6. You are ready to begin the installation process. Be sure to thoroughly read the version specific Release Notes prior to running the installer.

Upgrade on Windows

These instructions are for upgrading SharePlex on the Windows platform.

Important!

• If you are upgrading some SharePlex installations in a configuration, but not others, view the SharePlex Release Notes for interoperability support between versions.
• Perform the upgrade on all Windows machines that host databases involved in SharePlex replication.

• Do not uninstall SharePlex or the MKS Toolkit® environment before upgrading. Install the upgrade over the existing version.

• On Windows, install SharePlex on all nodes of each cluster, on the same port number, with identical path names. This is required to make the binaries and the required MKS Toolkit components available to all nodes, and to establish Registry entries.
• See Before you upgrade for any pre-installation items that apply to your SharePlex installation.

To run the upgrade

1. Log into Windows as the SharePlex Administrator.

2. (If using copy/append) Stop sp_sync_launcher on the target systems before applying the SharePlex upgrade.

   sp_ctrl> stop launcher

3. (Oracle as source only) In sp_ctrl, use the set param command to stop DDL replication (if active) by setting the SP_OCT_REPLICATE_ALL_DDL parameter to 0.

   sp_ctrl>set param SP_OCT_REPLICATE_ALL_DDL 0

   Important! Keep the setting at 0 until prompted otherwise.

4. Stop the SharePlex service:

   1. Run SpUtils from the shortcut on the Windows desktop.
   2. Select the SharePlex Services tab.
   3. Select the correct port, and then stop the SharePlex service.
   4. Close the utility.

5. Run the sp_setup installation program and follow the prompts:

   Prompt	Input
   Destination Folder	Install the upgrade into the existing SharePlex product directory.
   Port number	Select the port that this instance of SharePlex currently uses.
   Variable Data directory	Specify the existing SharePlex variable-data directory.
   Program Manager group	Specify the existing Programs menu location.
   MKS Platform Components	Appears if this version of SharePlex contains a new version of MKS Toolkit®. Accept the default Program Files location. If prompted to restart your system, you can postpone the restart until after you finish this installation.
   Confirm installation	Confirm the installation information.
   SharePlex license	Accept the existing license shown or enter a new one if applicable.
   Finish	If you were prompted to restart the system after you installed the MKS Toolkit files, you may do so at any time after exiting the installer.

6. Run the appropriate Database Setup utility:

   • Oracle: see Database Setup for Oracle
   • SQL Server: see Database Setup for SQL Server
7. From SpUtils, start the SharePlex service.
8. (Source only) To enable DDL replication again, set the the SP_OCT_REPLICATE_ALL_DDL parameter to 1.