This guide contains instructions for upgrading SharePlex environment. It is intended for administrators, consultants, analysts, and any other IT professionals tasked with upgrading SharePlex™.
For the complete SharePlex documentation set, go to https://support.quest.com/shareplex/technical-documents.
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.
This section contains important information that you need to know before you select a SharePlex installer and begin the upgrade procedure.
You will need the following information about the installation that you want to upgrade:
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.
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.
These requirements apply to SharePlex when it captures from an Oracle source database.
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:
To perform conversion with an Oracle client on Linux
To perform conversion with an Oracle client on Windows
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.
If you have received one-off builds of SharePlex, confirm that those builds are included as fixes in the new release that you are installing. This applies to Linux/Unix only.
To verify one-offs
Run the sp-bininfo utility from the util subdirectory of the product directory of your current SharePlex installation.
$ cd path_to_SharePlex_proddir/util
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.
The SharePlex installer on Linux and Unix is a self-extracting installation file with the extension .tpm.
Oracle and Open Target:
There is a separate SharePlex installer build for each supported platform.
For Oracle Solaris (Sun), there is a separate SharePlex installer build for each supported operating system version. If the operating system version that you have is not listed, choose the highest number that is below your version.
The installer creates a temporary target directory, within the current directory, for extraction. This temporary target directory is removed upon installation completion. You can extract the files to a file system that is separate from the SharePlex installation location by using the -t option when running the .tpm file. For additional options, see Advanced SharePlex installer options.
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:
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.
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.
Go to the Quest Software Support page: http://support.quest.com/
Click Download Software.
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).
You are ready to begin the installation process. Be sure to thoroughly read the version specific Release Notes prior to running the installer.
These instructions are for upgrading SharePlex when configured for an Oracle database running on a Linux or Unix system.
To upgrade SharePlex in the current product directory
(If using copy/append) In sp_ctrl on the target systems, stop sp_sync_launcher before applying the SharePlex upgrade.
sp_ctrl> stop launcher
(If applicable) In sp_ctrl on the source system, use the set param command to stop DDL replication by setting the SP_OCT_REPLICATE_ALL_DDL parameter to 0.
sp_ctrl> set param SP_OCT_REPLICATE_ALL_DDL 0
Shut down the SharePlex instance that you are upgrading.
Verify that all SharePlex processes in that SharePlex instance are stopped, and stop any that are still running.
# ps -ef | grep sp_
sp_ctl> stop process
Run the SharePlex installation program.
Verify that the information shown on the first prompt corresponds to the Oracle version and platform that you are upgrading.
Follow the prompts to supply the following information:
Select the current product directory of the SharePlex installation you are upgrading.
|SharePlex Admin group||
Select the DBA-privileged group to which the SharePlex Administrator user belongs.
|Proceed with upgrade?||Press Enter to confirm the SharePlex environment and proceed with the upgrade.|
|License key (do you want to upgrade?)||
Press Enter to accept the default of N (no) to keep the existing license, or enter Y to specify a new license key if required for this upgrade.
(If Y was selected) Enter the new license key that you received from Quest.
|Customer name||If you added the license key, enter the SiteMessage text string provided by Quest with the license key.|
Log in to the system as the user that will be named as the SharePlex Administrator during this installation. This user will own the installation files and binaries.
If sp_cop is running, shut it down.
Grant executable permissions to the file.
Run the .tpm file. If installing SharePlex in a cluster, run the installer from the primary node (the one to which the shared disk is mounted)
Verify that the information shown on the first screen corresponds to the Oracle version and platform you are upgrading.
You are prompted for the following:
Select <New Installation>.
Product directory location (path)
Enter the path to the SharePlex installation directory.
If the specified directory does not exist, the installer creates it. If the directory exists, it must be empty. The installer quits if the directory contains prior SharePlex installations or other files.
In a cluster, install on the shared disk. For more information, see Installation and setup for Oracle cluster.
Variable data directory location
Specify an empty directory. The installer creates the specified directory if it does not exist. Important! Do not install this directory into the SharePlex product directory.
In a cluster, install the variable-data directory on the shared disk. For more information, see Installation and setup for Oracle cluster.
SharePlex Admin group
Enter the DBA-privileged group to which the SharePlex Administrator user belongs, which will own the SharePlex binaries. If the default group of the SharePlex Administrator is oinstall, select any option, and make certain this user is listed under oinstall in the etc/group file. For more information, see Installer checklist.
TCP/IP port for SharePlex
Enter the port number to use for SharePlex TCP/IP communications.
License key (do you have?)
Press Enter to accept the default of Y (yes). If you do not have a license, enter no.
For licensing on a cluster, see Installation and setup for Oracle cluster
At any point before you run SharePlex you can add the license key with the splex_add_key utility. For more information, see SharePlex license utilities.
Enter the license key you received from Quest.
Enter the SiteMessage text string provided by Quest with the license key.
Note: The installer will upgrade the default variable-data directory that is listed in the defaults.yaml file, which is located in the data sub-directory of the product directory.
If you have more than one variable-data directory that needs to be upgraded, perform the following steps for each of those directories.
Within the variable-data directory that you exported, create a subdirectory named “downgrd” with the same owner and permissions that are assigned to the other subdirectories in that directory.
chmod 775 downgrd
Run the ora_setup Database Setup utility for each variable-data directory in the installation of SharePlex that you upgraded. See Database Setup for Oracle.
Start SharePlex using the following syntax with options as appropriate.
$ cd /productdir/bin
$ ./sp_cop [-uidentifier] &
(If applicable) In sp_ctrl on the source system, set the the SP_OCT_REPLICATE_ALL_DDL parameter to 1.
sp_ctrl> set param SP_OCT_REPLICATE_ALL_DDL 1
To upgrade SharePlex to a new product directory
Shut down sp_cop.
Export the SP_SYS_VARDIR environment variable to the existing variable-data directory (not the temporary one) that you want to upgrade.
Within the existing variable-data directory that you exported, create a subdirectory named “downgrd” with the same owner and permissions that are assigned to the other subdirectories in that directory.
chmod 775 downgrd
Run the ora_setup Database Setup utility using the existing SharePlex Oracle database user. See Database Setup for Oracle.
$ /productdir/bin/sp_cop [-uidentifier] [-s] &