Chat now with support
Chat with Support

SharePlex 9.0 - Installation Guide

About this Guide Conventions used in this guide System Requirements SharePlex pre-installation checklist Installation and setup for Oracle cluster Installation and setup for cloud-hosted databases Download SharePlex Install SharePlex on Linux and UNIX Install SharePlex on Windows Assign SharePlex users to security groups Set up an Oracle environment for replication Set up replication between SQL Server databases Set up replication between different database types Basic SharePlex demonstrations Advanced SharePlex demonstrations Solve Installation Problems Uninstall SharePlex SharePlex Utilities Advanced installer options Install SharePlex as root Run the installer in unattended mode SharePlex installed items

SQL Server Setup (mss_setup)

Overview

Run the Database Setup utility for SQL Server (mss_setup) on a Microsoft SQL Server system to establish SharePlex as a SQL Server database user. This utility creates the following:

  • A SharePlex user account with full DBA privileges
  • Tables and indexes for use by SharePlex and owned by the SharePlex user in a database of your choosing
  • A default database connection.

Supported databases

Microsoft SQL Server on Windows

Guidelines for use

  • A system DSN (data source name) must exist for the SQL Server database. SharePlex Post uses the DSN to connect to the database through ODBC.
  • Run the Database Setup utility on all SQL Server instances in the SharePlex replication configuration.
  • Within a cluster, run the Database Setup utility on the node to which the shared disk that contains the variable-data directory is mounted.
  • For consolidated replication, run the Database Setup utility for each variable-data directory.

Required privileges

Review the following requirements to ensure that the setup succeeds.

  • The Database Setup utility must be run as a SQL Server System Administrator in order to grant SharePlex the required privileges to operate on the database and to create the SharePlex database account and objects.
  • (Cloud installations) Common restrictions on privileges in cloud-hosted database services make it difficult for the setup utility to succeed in every possible type of scenario. To ensure that the database setup succeeds, only use the setup utility for the following purposes: To do a first-time database setup with a new SharePlex user, or, to modify an existing SharePlex user that either owns the database or has access to it.

Run Database Setup for SQL Server

  1. Shut down any running SharePlex processes and sp_cop on the SQL Server system.

  2. Run the mss_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.

    C:\users\splex\bin> mss_setup -p9400

Table 9: Setup prompts and responses

Prompt Response

Enter the Microsoft SQL Server DSN name or connection string [] :

 Enter a connection string or a data source name (DSN) that connects to SQL Server. Make certain the DSN is a system DSN, not a user DSN.

Enter the Microsoft SQL Server Administrator name :

 Enter the name of the SQL Server Administrator. This user will perform the setup work on the SharePlex account and schema.

Enter the password for the Administrator account :

 Enter the password of the Administrator.

Enter the database name:

Enter the name of the database where you want to install the SharePlex objects.

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.

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

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

Enter the name of the existing SharePlex login:

Enter the name of the new SharePlex login:

One of these prompts is displayed depending on whether you elected to create a new user or use an existing user. Enter the name of the SharePlex user.

 

Enter the password for login:

Enter the password of the SharePlex user account.

Re-enter the password for login :

 Enter the SharePlex password again.

Will this database be used as a source?

 Accept the default of n if the database will only be a target. Enter y if this database will be a source database for SharePlex. A response of y prompts the setup to prepare the database for data capture and installs the SharePlex account and objects.

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

Completed SharePlex for Microsoft SQL Server database configuration

SharePlex User name: splex

Database name: db1

Target specification in SharePlex configuration: r.db1

Teradata Setup (td_setup)

Overview

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 10: 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:

(or...)

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:

(or...)

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;

Database Setup for SQL Server

Overview

Run the Database Setup utility for SQL Server (mss_setup) on a Microsoft SQL Server system to establish SharePlex as a SQL Server database user. This utility creates the following:

  • A SharePlex user account with full DBA privileges
  • Tables and indexes for use by SharePlex and owned by the SharePlex user in a database of your choosing
  • A default database connection.

Supported databases

Microsoft SQL Server on Windows

Guidelines for use

  • A system DSN (data source name) must exist for the SQL Server database. SharePlex Post uses the DSN to connect to the database through ODBC.
  • Run the Database Setup utility on all SQL Server instances in the SharePlex replication configuration.
  • Within a cluster, run the Database Setup utility on the node to which the shared disk that contains the variable-data directory is mounted.
  • For consolidated replication, run the Database Setup utility for each variable-data directory.

Required privileges

Review the following requirements to ensure that the setup succeeds.

  • The Database Setup utility must be run as a SQL Server System Administrator in order to grant SharePlex the required privileges to operate on the database and to create the SharePlex database account and objects.
  • (Cloud installations) Common restrictions on privileges in cloud-hosted database services make it difficult for the setup utility to succeed in every possible type of scenario. To ensure that the database setup succeeds, only use the setup utility for the following purposes: To do a first-time database setup with a new SharePlex user, or, to modify an existing SharePlex user that either owns the database or has access to it.

Run Database Setup for SQL Server

  1. Shut down any running SharePlex processes and sp_cop on the SQL Server system.

  2. Run the mss_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.

    C:\users\splex\bin> mss_setup -p9400

Table 9: Setup prompts and responses

Prompt Response

Enter the Microsoft SQL Server DSN name or connection string [] :

 Enter a connection string or a data source name (DSN) that connects to SQL Server. Make certain the DSN is a system DSN, not a user DSN.

Enter the Microsoft SQL Server Administrator name :

 Enter the name of the SQL Server Administrator. This user will perform the setup work on the SharePlex account and schema.

Enter the password for the Administrator account :

 Enter the password of the Administrator.

Enter the database name:

Enter the name of the database where you want to install the SharePlex objects.

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.

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

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

Enter the name of the existing SharePlex login:

Enter the name of the new SharePlex login:

One of these prompts is displayed depending on whether you elected to create a new user or use an existing user. Enter the name of the SharePlex user.

 

Enter the password for login:

Enter the password of the SharePlex user account.

Re-enter the password for login :

 Enter the SharePlex password again.

Will this database be used as a source?

 Accept the default of n if the database will only be a target. Enter y if this database will be a source database for SharePlex. A response of y prompts the setup to prepare the database for data capture and installs the SharePlex account and objects.

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

Completed SharePlex for Microsoft SQL Server database configuration

SharePlex User name: splex

Database name: db1

Target specification in SharePlex configuration: r.db1

Advanced installer options

The use of additional command line options when installing SharePlex is usually not necessary. These options are typically employed when working with Support to resolve specific issues.

The installer command line options and their descriptions follow:

USAGE

tpm [<options>] [ [<package> | <location>] ... ]

 

OPTIONS

-v, --verbose Turns verbose mode on

-h, -?, --help Prints out this message

--debug Starts the interactive debugger

--info Print information about installed

 

packages

--install Perform product installation

--remove Perform product deinstallation

--commit Commit last installation

--revert Revert last installation

-t, --tmp <directory> Temporary directory location

-d, --directory <directory> Working directory

-f, --force Unconditionally update existing files

--no-cleanup Do not perform cleanup on failure

--nocleanup Same as --no-cleanup, for compatibility

--list List the content of the archive

--extract Extract the archive into the current directory

-r, --responses <yaml file> Use the responses from a specified file

-D, --defaults Accept default answers

-l, --log Leave the installation log file

DESCRIPTION

Provides package management facilities. Packages can be installed, removed, reverted or committed. The utility also figures out its role based on the command name of its invocation path. For example, "tpm-install" is treated as "tpm --install", "tpm-remove" as "tpm --remove", etc.

It can also be invoked as part of a self extracting package invocation, in which case it is treated as "tpm --install".

Note: All command line options for the .tpm file are preceded by two dashes.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating