SharePlex 12.0 - Upgrade Guide

Upgrade on Linux/Unix for Oracle Database

These instructions are for upgrading SharePlex when configured for an Oracle or PostgreSQL database running on a Linux or Unix system.

To upgrade SharePlex in the current product directory:

1. Log in to the system as the SharePlex installation owner.

2. (If using copy/append) In sp_ctrl on the target systems, stop sp_sync_launcher before applying the SharePlex upgrade.

   sp_ctrl> stop launcher

3. (applicable only for Oracle source) 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

4. Shut down the SharePlex instance that you are upgrading.

   sp_ctrl> shutdown

   Note: Before shutting down the SharePlex instance, stop the Capture process if your source database is PostgreSQL with logical replication.

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

6. (Optional) If you need to upgrade the Oracle or PostgreSQL database, do so now.
7. Tar up the existing SharePlex product directory and move the tar file to different location as a backup.

8. Run the SharePlex installation program.

   1. 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.
   2. If sp_cop is running, shut it down.
      sp_ctrl> shutdown
   3. Copy the installation file to a temporary directory where you have write permissions.
   4. Grant executable permissions to the file.
      #chmod 555installation_file
   5. 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)
      # ./installation_file
   6. Verify that the information shown on the first screen corresponds to the version and platform (Oracle or PostgreSQL) you are upgrading.
9. Verify that the information shown on the first prompt corresponds to the version and platform (Oracle or PostgreSQL) that you are upgrading.
10. Follow the prompts to supply the following information:

    Prompt	Input
    Installation type	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.
    Please specify platform for license key (select a number):	Please select the appropriate number from the following list of platforms to install the license key: 1) Oracle 2) File 3) JMS 4) Kafka 5) SQL Server 6) Postgres 7) MySQL 8) Snowflake 9) MariaDB 10) Event Hubs 11) All Platforms q) Quit License Utility Note: To install a trial version of SharePlex, users need to select the All Platforms option.
    License key	(If Y was selected) Enter the new license key that you received from Quest.

    Note: The installer will upgrade the default variable-data directory that is listed in the default.yaml file, which is located in the data sub-directory of the product directory.
    

11. Run the database setup utility for each variable-data directory in the installation of SharePlex that you upgraded. See the SharePlex Installation and Setup Guide to run the various database setups.

12. Start SharePlex using the following syntax with options as appropriate.

    $ cd /productdir/bin

    $ ./sp_cop [-uidentifier] &

    where:

    • -uidentifier starts sp_cop with the unique identifier for the instance you are upgrading, and is only needed if there are multiple instances of sp_cop running on the system.

    Note: After upgrading, to bring up your existing setup, activate the same configuration file again if your source is PostgreSQL with logical replication. This will add newly created SharePlex internal tables to the publication used for logical replication before starting the Capture process.

13. (applicable only for Oracle source) 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:

2. Shut down sp_cop.

   sp_ctrl> shutdown

2. (Optional) If you need to upgrade the Oracle or PostgreSQL database, do so now.
3. Tar up the existing SharePlex product directory and move the tar file to different location as a backup.
4. Run the SharePlex installer and, when prompted to specify the product directory location, select New Installation.

   You are prompted for the following:
   

   Prompt	Input
   Installation type	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. (Applicable only for Oracle source) In a cluster, install on the shared disk. For more information, see Installation and setup for Oracle cluster in the Installation and Setup Guide document.
   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. (Applicable only for Oracle source) In a cluster, install the variable-data directory on the shared disk. For more information, see Installation and setup for Oracle cluster in the Installation and Setup Guide document.
   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 in the Installation and Setup Guide document.
   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 in the Installation and Setup Guide document. 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 in the Installation and Setup Guide document.
   Please specify platform for license key (select a number):	Please select the appropriate number from the following list of platforms to install the license key: 1) Oracle 2) File 3) JMS 4) Kafka 5) SQL Server 6) Postgres 7) MySQL 8) Snowflake 9) MariaDB 10) Event Hubs 11) All Platforms q) Quit License Utility Note: To install a trial version of SharePlex, users need to select the All Platforms option.
   License key	Enter the license key you received from Quest.

5. Export the SP_SYS_VARDIR environment variable to the existing variable-data directory (not the temporary one) that you want to upgrade.
6. Run the database setup utility using the existing SharePlex database user. See the SharePlex Installation and Setup Guide to run the various database setups.
7. Start sp_cop.
   $ /productdir/bin/sp_cop [-uidentifier] [-s] &

Upgrade on Linux/Unix for Open Target Databases

These instructions are for upgrading SharePlex when configured for an open target database running on a Linux or Unix system.

To run the upgrade:

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

2. (Reinstallations) If sp_cop is running, shut it down.
3. Copy the installation file to a temporary directory where you have write permissions.

4. Grant executable permissions to the file.

   # chmod 555 installation_file

5. 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)

   # ./installation_file

6. You are prompted for the following:

   Prompt for:	Input
   Installation type	Select <New Installation>.
   Product directory location (path)	Enter the path to the existing SharePlex installation directory.
   Variable data directory location	Enter the name of the existing variable-data directory.
   SharePlex Admin group	Enter the DBA-privileged group to which the SharePlex Administrator user belongs, which owns the SharePlex binaries.
   TCP/IP port for SharePlex	Enter the port number of the SharePlex instance you are upgrading.
   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.
   Please specify platform for license key (select a number):	Please select the appropriate number from the following list of platforms to install the license key: 1) Oracle 2) File 3) JMS 4) Kafka 5) SQL Server 6) Postgres 7) MySQL 8) Snowflake 9) MariaDB 10) Event Hubs 11) All Platforms q) Quit License Utility Note: To install a trial version of SharePlex, users need to select the All Platforms option.
   License key	(If Y was selected) Enter the new license key that you received from Quest.

   The installer displays the location of the install log file and then quits.

7. Run the appropriate Database Setup utility for your database to upgrade the SharePlex database account. See SharePlex Utilities

8. Repeat all of the installation procedures for all Unix and Linux machines that host an Open Target database.

Upgrade on Windows

These instructions are for upgrading SharePlex on the Windows platform.

To upgrade SharePlex from 10.x to 12.0 on Windows for Oracle target:

1. Log into Windows as the SharePlex Administrator.

2. On the target, set the SP_OPO_UPDATE_SCN parameter to 1 and restart the Poster process.

3. On the target, run show_scn for the source Oracle Data Source ID. The Poster process will be in a "stopped by user" state.

4. Note down the SCN value from the last posted SCN. (In case of multiple targets, select the minimal SCN value.) Also, copy the reconcile commands from the show_scn output.

5. Deactivate the configuration on the source.

6. Shut down SharePlex on the source and target/s.

7. Run ora_cleansp on the source and respective cleanup utility on targets, even if the target SharePlex is not upgraded.

8. Take a backup of the configuration and relevant files from the 10.x installation var directory.

9. 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.
   Confirm installation	Confirm the installation information.
   Finish	If you were prompted to restart the system, you may do so at any time after exiting the installer.

10. Uninstall SharePlex and PTC Nutcracker.

11. Install version 12.0 with separate prod and var directories, following the installation process. For more information about the installation process see SharePlex Installation and Setup Guide .

12. Run the appropriate setup utility for the upgraded SharePlex.

13. Using spUtils, add a license for the respective database, install the SharePlex service, and start the service.

14. Run sp_ctrl and stop the Poster process on the target.

15. Activate the configuration using the SCN noted in step 4.

16. On the target, execute the reconcile commands from the show_scn output in sp_ctrl.

17. On the target, start the Poster service.

18. Verify that replication is working correctly.

To upgrade SharePlex from 10.x to 12.0 on Windows for open targets:

1. Log into Windows as the SharePlex Administrator.

2. On the source Oracle database, run SELECT current_scn FROM V$DATABASE; and note down the SCN value.

3. Stop the capture service on the source and wait for the Poster queue to be empty.

4. Deactivate the configuration on the source.

5. Shut down SharePlex on the source and target/s.

6. Run ora_cleansp on the source and respective cleanup utility on targets, even if the target SharePlex is not upgraded.

7. Take a backup of the configuration and relevant files from the 10.x installation var directory.

8. 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.
   Confirm installation	Confirm the installation information.
   Finish	If you were prompted to restart the system, you may do so at any time after exiting the installer.

9. Uninstall SharePlex and PTC Nutcracker.

10. Install version 12.0 with separate prod and var directories, following the installation process.For more information about the installation process see SharePlex Installation and Setup Guide .

11. Run the appropriate setup utility for the upgraded SharePlex.

12. Using spUtils, add a license for the respective database, install the SharePlex service, and start the service.

13. Run sp_ctrl and activate the configuration using the SCN noted in step 2.

14. Verify that replication is working correctly.

Note: If you are upgrading SharePlex from Oracle to an Open Target, it is recommended to perform the upgrade when there are no transactions on the database. Users may encounter out-of-sync issues on the Open Target, which will need to be resolved manually. Additionally, error logs related to the processing of duplicate records may appear in the target logs.

Verify Partition Schemes

If you are upgrading from a SharePlex version earlier than 9.0, the method of creating and storing partition schemes and row partitions for horizontal partitioning has changed. This information no longer is stored in the database.

When you run database setup during an upgrade, it converts the data from the SHAREPLEX_PARTITION table to the new internal storage format. After the conversion, you can view the partitions with the view partitions command in sp_ctrl to ensure that the partitions converted properly.

Note: For more information about the view partitions command, see theSharePlex Reference Guide.

To view row partitions:

1. Run sp_ctrl on the source system.

2. Issue the following command with either option, depending on whether you want to view all partitions or just those for a particular partition scheme.

   sp_ctrl> view partitions for {scheme_name | all}

The following is an example of converted partition schemes. Note that the conversion program populates the Name field with the name of the queue from the Route column.

Scheme        Name           Route                            Hash     Condition
-----------   -------------  ------------------------------   ------   ---------------
HASH4         hash           sys02:hash|#@o.ora112            4        ROWID
TEST_CT       highvalues     sys02:highvalues@o.ora112                 sales>=10000
TEST_CT       lowvalues      sys02:lowvalues@o.ora112                  sales<10000