Chat now with support
Chat with Support

SharePlex 8.6.6 - Reference Guide

About this guide Conventions used in this guide SharePlex commands SharePlex parameters SharePlex utilities Appendix B: SharePlex environment variables

sp_wallet utility

SharePlex utilities > sp_wallet utility

Description

Use the sp_wallet utility to provide the Oracle Wallet password to SharePlex. SharePlex uses the wallet password to access the TDE Master Encryption Key. SharePlex uses the TDE Master Encryption Key to decrypt TDE-protected data in the redo log that must be replicated.

Grant read permission on the Oracle Wallet file to the dba group before using sp_wallet.

Supported databases

Oracle on Unix, Linux, and Windows

Run sp_wallet

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]

Trigger Scripts

SharePlex utilities > Trigger Scripts

Description

SharePlex provides three interactive scripts that you can run in SQL*Plus to manage triggers so that they do not interfere with replication. Review the following points before you run the scripts.

  • To run the trigger scripts, you must have access to both the SYS and DBA objects. If the SharePlex database account was set up properly during installation, that account has this access.

  • After applying an Oracle patch (which sometimes creates or modifies triggers), re-run sp_add_trigger.sql on the target system if triggers are not disabled.
  • The scripts reside in the util sub-directory of the SharePlex product directory.

  • The SharePlex trigger scripts support row-level triggers only. Statement-level triggers must be disabled/enabled for the SharePlex user separately.
  • Triggers that modify data in tables NOT being replicated and do not affect tables in the replication configuration can fire on the target system without special treatment. However, the scripts operate on all objects in the Oracle instance, whether or not they are part of replication.
  • SharePlex provides other interactive scripts for managing triggers. For more information about sp_add_trigger.sql and the other SharePlex trigger scripts, see the SharePlex Reference Guide.
  • The scripts must be run for target objects. Do not run them on the source objects unless you are using peer-to-peer replication.
  • The scripts should not be used if source and target objects are both on the same machine. In this configuration, the user can disable triggers on target objects.

Supported databases

Oracle on supported platforms

sp_add_trigger.sql

Use sp_add_trigger.sql when you cannot disable triggers on target objects, such as for peer-to-peer and high-availability configurations. This script changes the triggers so that they ignore the SharePlex Oracle user associated with the Post process, but fire for all other users. It inserts the following WHEN clause into each trigger in the database.

when user != ‘SharePlex_username’ begin

The script prompts for the SharePlex user name, and then it modifies the triggers. It does not modify triggers belonging to SYS, SYSTEM, and SCOTT.

Syntax

@absolute_pathname/sp_add_trigger.sql

sp_change_trigger.sql

Use sp_change_trigger.sql to replace the name of the SharePlex user in the WHEN clause that was created with sp_add_trigger.sql. It prompts for the current SharePlex user name and for the new user name. Change the SharePlex user in Oracle before you run this script.

Syntax

@absolute_pathname/sp_change_trigger.sql

sp_remove_trigger.sql

Use sp_remove_trigger.sql to remove the WHEN clause created with sp_add_trigger.sql. It prompts for the SharePlex user name and then automatically removes the WHEN clause from all of the triggers. Use this script if you no longer will be replicating to those tables. If you continue to use SharePlex to replicate to those tables without disabling the triggers, the triggers will fire when SharePlex posts data, and SharePlex will generate out-of-sync errors.

Syntax

@absolute_pathname/sp_remove_trigger.sql

Appendix B: SharePlex environment variables

Appendix B: SharePlex environment variables

SharePlex uses the following environment variables, which you may need to set in certain situations. Usually you must perform additional steps before or after setting a variable, so refer to the recommended instructions before setting a SharePlex variable.

Environment Variable Description
EDITOR Sets the default ASCII text editor for sp_ctrl commands that use one, for example the create config command. See Set a default editor for sp_ctrl.
HOST Sets a host name for all locally run sessions of sp_ctrl. To set a per-session host, see Execute commands in sp_ctrl.
SP_COP_TPORT Sets a non-default port number for an instance of SharePlex. The default port number is 2100. You may need to set a different port number if you are setting up additional instances of sp_cop (see Run multiple instances of SharePlex) or if a different port number than 2100 must be used (see Set the SharePlex port number).
SP_SYS_HOST_NAME Sets the virtual IP address (also known as the global cluster package name) on a clustered system, such as Oracle RAC. This variable must be set on all cluster nodes. For more information about configuring SharePlex in a cluster, see the SharePlex Installation Guide.
SP_SYS_VARDIR Sets the full path to the SharePlex variable-data directory so that sp_cop can locate the configuration data, queues, logs and other information. If there is only one instance of sp_cop on the local system, this variable is set by default*. If there are multiple instances of sp_cop on the local system, always set this variable to point to the correct variable-data directory of an instance before setting any other SharePlex variables for that instance. For more information, see Run multiple instances of SharePlex.
SP_SYS_SECURE_MODE

Suppresses the output of the compare and repair SQL log file for all compare and repair runs while the current instance of SharePlex is running. This variable must be set before starting SharePlex, so if the sp_cop process is running it must be restarted after setting this variable. When sp_cop is run with this environment variable, the compare and repair commands will not put data into SQL files and the Post process will not put data into the SharePlex error log.

* On Unix and Linux, the variable-data directory is set in the proddir/data/defaults.yaml file. On Windows, it is set in the Windows Registry.

To set an environment variable in Unix or Linux

ksh shell:

export variable_name=value

csh shell:

setenv variable_name value

 

ksh shell:

export SP_SYS_VARDIR=full_path_of_variable-data_directory

csh shell:

setenv SP_SYS_VARDIR full_path_of_variable-data_directory

To set an environment variable on Windows

Set the environment variable by adding it to the SharePlex node of the Windows Registry.

Important! Incorrect Registry settings can adversely affect the operation of SharePlex. Consult a System Administrator if you need help with this procedure.

  1. Shut down the SharePlex service.
  2. Open the Run dialog. The location varies with the Windows version.
  3. In the Run dialog, type regedit to run the Registry Editor.
  4. Expand the SharePlex node:

    \HKEY_LOCAL_MACHINE\Software\Wow6432node\Quest Software\SharePlex

  5. Right click the port number of the SharePlex instance to which you want to add a variable, then select New, then String Value.
  6. Under the Name column, right click the new variable, then select Rename.
  7. Type the correct name.
  8. Double click the new variable.
  9. Under Value Data, enter the string for the new variable and then click OK.
  10. Exit the Registry.

 

Related Documents