Chat now with support
Chat with Support

SharePlex 9.0.2 - Reference Guide

About this guide Conventions used in this guide SharePlex commands SharePlex parameters General SharePlex utilities Database Setup utilities SharePlex environment variables

Teradata Setup (td_setup)


Run the Database Setup utility for Teradata (td_setup) on a Teradata system to establish a user account and database for use by SharePlex.

Supported databases

Teradata on supported platforms

Requirements for use

  • An ODBC Data Source Name (DSN) must exist for SharePlex to use. You will be prompted for this name during setup. See the Teradata ODBC documentation for instructions.
  • Run the setup utility on all target Teradata instances in the SharePlex replication configuration.
  • Within a server cluster, run the setup utility on the node to which the shared disk that contains the SharePlex variable-data directory is mounted.
  • For consolidated replication, run the setup utility for each variable-data directory on the Teradata target.

Required privileges

The setup utility must be run as a Teradata Administrator in order to grant SharePlex the required privileges to operate on the database and to create the SharePlex database account.

Run Database Setup for Teradata

  1. Shut down any running SharePlex processes and sp_cop on the target system.
  2. Run the td_setup program from the bin subdirectory of the SharePlex product directory.

    Important! If you installed the SharePlex instance on any port other than the default of 2100, use the ‑p option to specify the port number. For example, in the following command the port number is 9400.

    $/users/splex/bin> td_setup ‑p9400

Table 8: Setup Prompts and Responses

Prompt Response

Please enter the full directory path of the Teradata ODBC driver:

Enter the full path to the Teradata ODBC driver library. This step initializes the driver location within the setup utility so that the rest of the setup can take place. It requires a second running of the setup utility to complete the setup steps.

Please run td_setup again to create the tables, login and user accounts needed to run SharePlex replication.

Run the setup utility again, including the port number if you installed SharePlex on any port other than 2100:

$/users/splex/bin> td_setup -p9400

Enter the DSN name or connection string []:

Enter a connection string or a data source name (DSN) that connects to Teradata.

Enter the Teradata Administrator name:

Enter the name of the Teradata Administrator. This user will perform the work on the SharePlex account.

Enter the password for the Administrator account:

Enter the password of the Administrator.

Would you like to create a new SharePlex user [y]:

Press Enter to accept the default to create a new SharePlex database user account or enter n to use an existing SharePlex account.

Enter the name of the new SharePlex user:


Enter the name of the existing SharePlex user:

Enter the name of the new or existing SharePlex user, depending on which option you chose in the previous step.


Enter the password for new SharePlex user:


Enter the password for existing SharePlex user:

Enter the password of the new or existing SharePlex user account.

Re-enter the password for new SharePlex user:

This prompt is only shown if you created a new user. Enter the SharePlex password again.

Enter the name of the database:

Accept the default or enter a different name for the database.

Database name database does not exist. Would you like to create it? [y]:

If this prompt is displayed, the specified database does not exist. Press Enter to have the setup utility create it for you.

A successful setup terminates with a message similar to the following:

Completed SharePlex for Teradata database configuration

SharePlex User name: splex

Database name: splex

Target specification in SharePlex configuration: r.splex

Grant additional database privileges

The setup utility creates the following objects:

  • a database user by which SharePlex Post will operate (which also owns a database)
  • a database into which SharePlex can install its internal objects (which can be the database owned by the SharePlex Post user or a different one)

The setup utility then prompts you to specify any additional Teradata databases that you want to include as replication targets. For each of those databases, the utility issues the following grant to the SharePlex user:

grant all on database to SharePlex_user;

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.
HOST Sets a host name for all locally run sessions of sp_ctrl.

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 one of the following is true:

  • You are setting up additional instances of sp_cop.
  • A different port number than 2100 must be used.

Sets the host name that SharePlex binds to during configuration activation. This variable is used for the following:

  • 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.
  • In the case where there are multiple network cards on Windows, it must be set to the network card or IP address that you want SharePlex to use as the local host. Otherwise, if the server reboots after the SharePlex configuration is activated, the IP address may bind to a different network card from the one that is bound in the replication configuration.
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.

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

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating