Use the td_cleansp utility to remove the current replication state on a system where SharePlex is replicating to a Teradata target.
Caution: The effects of td_cleansp are not reversible. To stop replication without restoring it to an initial state, you might be able to use the abort config or purge config command.
To use this utility, the Korn (ksh) shell must be installed on the system. The utility calls this shell during processing.
td_cleansp does the following on the target system:
td_cleansp preserves the following:
Teradata on supported platforms
Run the td_cleansp utility from the bin sub-directory of the SharePlex product directory with the following syntax:
C:\users\splex\bin>td_cleansp [port number ] database_name/user_name
Enter the password at the prompt.
Enter the password for the Shareplex User :
Type Y to confirm that you want to run cleanup for this SharePlex instance.
Are you sure you want to perform the clean for '/splex/vardir/var2' and port 2200? [N] : Y
Use the SharePlex license utilities to view and add license keys to hosts in the SharePlex replication environment. Each installation of SharePlex requires a valid license key. There are three types of SharePlex license keys:
The current license model for SharePlex is to license for a specific host, which depending on edition is licensed by core(s) or socket(s) and specific message repository (i.e. database, JMS/text files) etc. Specifics of license terms should be obtained from your account manager.
If you do not have a valid license key, you may obtain one from Quest Technical Support or your Quest sales representative. Use the appropriate procedure in this documentation to obtain the necessary information to support your license request.
On Unix and Linux systems, separate utilities are used to:
Use the splex_uname utility to collect information about the local host that is required for Quest to generate a license key. Run this utility from the util sub-directory of the SharePlex product directory.
The information is similar to the following example:
Local system info: Host Name = irvspxu09 Host ID = 2198894273 (831076C1 HEX) Operating System = SunOS Machine model = SUNW,UltraAX-i2 CPU Type = sparc9 CPU Speed = 500 Number of CPUs = 1
Use the splex_add_key utility to add a license key to a machine during the installation of SharePlex or afterward to convert from one type of license to another.
You can use the splex_add_key utility as follows:
To run splex_add_key
If SharePlex is running, shut it down.
Run splex_add_key from the install sub-directory of the SharePlex product directory.
Choose the appropriate option for how to install the key:
SharePlex License Utility 1) Read license key from file 2) Enter license key manually 3) Add license key for alternate host q) Quit License Utility Enter option:
Note: Use option 3 when installing on secondary nodes in a cluster. To install SharePlex in a cluster, see Installation and setup for Oracle cluster .
If you are entering the key manually, type the license key exactly as you received it from Quest, including the SPLEXKEY= string if one prepends the key, any spaces, and any capitalization. Press Enter when finished typing the key.
Enter the SiteMessage text string provided by Quest with the license key.
Note: If you selected option 3 to install in a cluster, the utility continually prompts for another machine ID to license, until you exit the license utility.
Use the splex_get_key utility to view the SharePlex license key, license type, and expiration date on a machine. Run this utility from the install sub-directory of the SharePlex product directory.
The information is similar to the following example:
$ /splex/proddir/install/splex_get_key Customer Name = Quest License Key = EANLCF3P56F8M1JB1K6RBJCBB6TBEP0 Product Name = SharePlex Oracle License type = demo key Expired on = 01/01/2008 12:00 AM
On Windows platforms, all licensing functions are performed through the SpUtils utility, including viewing the machine ID for a system. Launch the SpUtils utility from the shortcut on the Windows desktop.
Select the Information tab to view information about the local host that is required for Quest to generate a license key. In a cluster, run SpUtils on each node.
Use SpUtils to add a license key to a machine during the installation of SharePlex or afterward to convert from one type of license to another. In a cluster, run SpUtils on the primary node.
If SharePlex is running, do the following:
Select the SharePlex port number from the Port list.
Click Add License, then type or paste the information exactly as you received it from Quest, as follows:
(Windows Cluster) To add a license for another node in a cluster, select the Add Alternate Host Id check box, then select the machine ID from the CPU ID list box. Repeat this step to add a license to all secondary nodes in the cluster.
Click OK to close the utility.
To start SharePlex, do the following:
Select the License Key tab, then select the port number (if running multiple SharePlex instances) for which you want to view license information.
In a cluster, run SpUtils on each node to view the local license.
Use the OTS utility (ODBC Test Suite) to test the ability of SharePlex to connect to an Open Target target database through a selected ODBC driver, and then post test data to different column types.
Open Target databases being considered for use with SharePlex.
Install the ODBC driver that you want to test.
(Linux) Set the following environment variables:
Set LD_LIBRARY_PATH to both of the following places:
OTS is available in the SharePlex build as well as a standalone version.
To install the standalone version:
Linux: Download the OTS package SPOodbc_test_suite-version-Beta-db_version-rh-40-amd64-m64.tpm. You are prompted for an installation directory.
Windows: Download the ots.exe file and place it in any directory.
Run OTS. If you are running it from within an installation of SharePlex or the standalone OTS package on Linux, run it from the util subdirectory. If you are running the Windows standalone version of OTS, run it from the installation directory.
A data source name (DSN) for the target database. The DSN must already exist. You are then prompted for the name and password.
OTS requires connection information for the tested database. Enter data source name (DSN) or connection string: mydsn
The OTS utility performs the following tests:
Create a report, dump files, and logs to support debugging and support cases.
Note: The report file is only generated when OTS can connect to the database. If the connection fails, the file is empty.
The OTS screen summary provides the following:
The detail results are organized into tables, one per datatype category, for example character datatypes or integer datatypes, as shown in the example.
Figure 1: Example detail table for character datatypes
Test: Character Datatypes -------------------------------------------------------------------------------- Name Size Nullable Insert Insert Update Delete Add Drop Trunc Pass/Fail Null Col Col -------------------------------------------------------------------------------- char 4096 Y P P P P P P P P nchar 4096 Y P P P P P P P P varchar 4096 Y P P P P P P P P sysname 30 Y P P P P P P P P nvarchar 4096 Y P P P P P P P P
The first three columns of each table (Name, Size, Nullable) are taken from a query to the ODBC driver. If the datatype is allowed to contain NULL, the Nullable column shows a Y (yes). Otherwise, it shows an N (no).
Following the query columns are columns that represent the tests that were performed. There is a row for each datatype that was tested. The SharePlex-supported operations that OTS tests are as follows:
The results also show the maximum and minimum (where applicable) storage values that were used for CHAR and VARCHAR datatypes in each test:
For each test of a datatype and operation, a P (pass) or F (fail) result is given, indicating whether or not SharePlex was able to perform that specific DML or DDL operation with that specific datatype.
The final column, Pass/Fail, shows at a glance whether the test passed or failed as a whole for a specific datatype. An F for any given operation type across the row triggers an F in the Pass/Fail column, meaning an overall failure of testing for that datatype.
The OTS utility is an initial screening tool for Open Target databases that are not yet Quest SharePlex Certified. Its purpose is to determine whether the types of operations that you want to replicate to a given target, with a given set of metadata, are likely to succeed, without requiring the installation or setup of SharePlex itself. For example, you could assume that SharePlex probably can post to a target if the outcome of the test is the following:
The OTS utility is only a first step. It is not a substitute for testing a full installation of SharePlex with your actual data, using actual operations that your source Oracle applications generate, and posting those replicated operations to your actual target tables in a test environment. Additionally, a successful test with OTS does not necessarily mean the database will be fully supported by SharePlex. See How to run OTS
To determine whether SharePlex will support a given Open Target database, the following are considered:
Does SharePlex Product Management approve the technical and market feasibility of supporting the database?
If the answer to questions 1 and 2 are yes, then the database is ODBC-approved. This means the database is then eligible for testing in the QA labs to answer question 3.
It is not realistic to test every possible edition, version, and platform of a given database. Based on market and technical factors, Product Management will determine which variants of a database will be tested. If those tests are successful, Product Management can then consider assigning the database a designation of SharePlex Certified.
Use the provision utility to change a host name or IP address in the SharePlex configuration.
The SharePlex processes rely on the host names or IP addresses of the source and target machines to route data properly. The provision utility enables you to change host names or IP addresses within an active SharePlex instance, without reactivating a new configuration.
Note: The provision utility does not change anything in the database. It only affects SharePlex internal objects.
All databases supported by SharePlex on all supported platforms
(SharePlex 7.0.2 only) Add the following parameter to the param-defaults file before you run provision:
SP_CFP_DEBUG I live int() 0x00000000
If running SharePlex on an AIX machine, set EXTSHM before running provision.
Run provision on all of the machines in the SharePlex configuration. Each machine can reference the IP addresses of all the other machines.
Using the command line of the operating system, run provision from the SharePlex variable-data directory with the following syntax:
provision -f old_name[:old_ipaddress] -t new_name[:new_ipaddress] [-n]
Runs provision without actually making any changes. Generates a report on the changes that provision will make.
Important! The best practice is to run provision with -n first, to make certain you agree with the potential changes, then run it without -n to make the changes.
|-p port||For Windows systems, specifies the port of the SharePlex instance for which provision is being run.|
provision -f oldname -t newname -n
The provision utility creates an undo_provision script that can be used to restore the host names and IP addresses to their previous state. Run the undo_provision script from the util subdirectory of the SharePlex product directory. There are no input arguments to this script.
The following may occur but do not affect the integrity of the replication environment: