Chat now with support
Chat with Support

SharePlex 8.6.6 - Installation Guide

About this Guide Conventions used in this guide Introduction to SharePlex SharePlex pre-installation checklist Set up SharePlex in an Oracle cluster Set up SharePlex on Amazon Cloud Download SharePlex UNIX Installation and Setup Windows Installation and Setup Assign SharePlex users to security groups Basic SharePlex demonstrations Advanced SharePlex Demonstrations Solve Installation Problems Uninstall SharePlex SharePlex Utilities Appendix A: Advanced installer options Appendix B: Install SharePlex as root Appendix C: SharePlex installed items

SQL Server Setup (mss_setup)

SharePlex Utilities > SQL Server Setup (mss_setup)

Overview

Run the SQL Server Setup program (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 using SQL Server Setup

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

Required privileges to run SQL Server Setup

Review the following requirements to ensure that the setup succeeds.

  • SQL Server Setup 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, use the setup utility only to set up replication to the following: A new database, to be created by the setup utility, where the SharePlex user is also created by the setup utility.An existing database, where the SharePlex user is an existing user that is either the owner of the database or has access privileges to the database.

Run SQL Server Setup

  1. Shut down any running SharePlex processes and sp_cop on the SQL Server system.
  2. Run the mss_setup utility 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 2: Setup prompts and responses

Prompt Response

Enter the DSN name or connection string [] :

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

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 name of the database :

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 user [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 new SharePlex user:

Enter the name of the existing SharePlex user:

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 of the SharePlex user :

Enter the password of the SharePlex user account.

Re-enter the password for the SharePlex user :

Enter the SharePlex password again.

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

PostgreSQL Setup (pg_setup)

SharePlex Utilities > PostgreSQL Setup (pg_setup)

Overview

Run the pg_setup program on a PostgreSQL system to establish a user account, schema, and tables for use by SharePlex.

Supported databases

All implementations of the PostgreSQL open-source database on supported platforms

Guidelines for using pg_setup

  • Run pg_setup on all target PostgreSQL instances in the SharePlex replication configuration.
  • Within a server cluster, run pg_setup on the node to which the shared disk that contains the SharePlex variable-data directory is mounted.
  • For consolidated replication, run pg_setup for each variable-data directory.
  • You can provide a connection string or a DSN. Note the following:

    Connection Type What to do
    Connection string You do not need to provide a user, password, or default database in a connection string. These will be added when you run the setup program. The connection string must have the port, server and driver defined. This is an example: Port=5444;server=localhost;driver=/u01/PostgresPlus/connectors/odbc/lib/edb-odbc.so;database=edb;
    DSN

    If you have a DSN defined, and you want to use it for the SharePlex connection, copy or link the ODBC files in which that DSN is defined (odbc.ini and odbcinst.ini) to the odbc subdirectory of the SharePlex variable-data directory. This prevents connection errors when the SharePlex processes connect to the database.

    If you do not have a DSN defined but want to use one, you can create it in the template files provided in the odbc subdirectory.

Required privileges to run pg_setup

Review the following requirements to ensure that the setup succeeds.

  • The setup utility must be run as a PostgreSQL Administrator in order to grant SharePlex the required privileges to operate on the database and to create the SharePlex database account.
  • (Symfoware only) If the person who is running the setup is not a Fujitsu Enterprise Postgres owner, set the environment variable LD_LIBRARY_PATH to include the path to the lib subdirectory in the Fujitsu Enterprise Postgres installation directory. The LD_LIBRARY_PATH is set in the .bash_profile file of the Fujitsu Enterprise Postgres owner.

    Example:

    export LD_LIBRARY_PATH= /opt/symfoserver64/lib:$LD_LIBRARY_PATH

    If you do not set this path, the following error occurs:

    symbol lookup error: /opt/fsepv95client64/odbc/lib/psqlodbca.so: undefined symbol: PQconnectdbParams

  • 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, use the setup utility only to set up replication to the following: A new database, to be created by the setup utility, where the SharePlex user is also created by the setup utility.An existing database, where the SharePlex user is an existing user that is either the owner of the database or has access privileges to the database.

Run pg_setup

  1. Shut down any running SharePlex processes and sp_cop on the target system.
  2. Run the pg_setup utility 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> pg_setup -p9400

Table 3: Setup prompts and responses

Prompt Response

Enter the PostgreSQL DSN name or connection string [] :

Enter a connection string or a data source name (DSN) that connects to the PostgreSQL target.

Enter the PostgreSQL Administrator name :

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

Enter the password for the Administrator account :

Enter the password of the Administrator.

Enter the replication target database name:

Enter the name of the database that you want to contain the SharePlex tables and other objects for use by SharePlex. You can enter the name of a new or existing 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 program create it for you.

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

Press Enter to accept the default to create a new SharePlex database user account and schema of the same name in the specified database, 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:

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 of the SharePlex user :

Enter the password of the SharePlex user account.

Re-enter the password for the SharePlex user :

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

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

Completed SharePlex for PostgreSQL database configuration

SharePlex User name: splex

Database name: ndb5

Target specification in SharePlex configuration: r.ndb5

HANA Setup (hana_setup)

SharePlex Utilities > HANA Setup (hana_setup)

Overview

Run the HANA Setup program (hana_setup) on a target HANA system to establish a user account, schema, and tables for use by SharePlex.

Supported databases

HANA on supported platforms

Guidelines for using HANA Setup

  • Run HANA Setup on all target HANA instances in the SharePlex replication configuration.
  • Within a server cluster, run HANA Setup on the node that has the mount point to the shared disk that contains the SharePlex variable-data directory.
  • For consolidated replication, run HANA Setup for each variable-data directory.
  • The only supported connection method to HANA is by connect string. Connection through a DSN is not yet supported.

  • Make certain that you assign the required permissions that are shown in this setup process.

Required privileges to run HANA Setup

HANA Setup must be run as a HANA Administrator in order to grant SharePlex the required privileges to operate on the database and to create the SharePlex database account.

Run HANA Setup

  1. Shut down any running SharePlex processes and sp_cop on the target system.
  2. Run the hana_setup utility 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> hana_setup -p9400

Table 4: HANA Setup Prompts and Responses

Prompt Response

Enter the connection string [] :

Enter a connection string that connects to the HANA database system. The required components of a connection string for SharePlex to connect to HANA are:

  • SERVERNODE: The name of the target HANA server, then a colon, then the HANA port number.
  • DRIVER: The path to the HANA ODBC driver.
  • CHAR_AS_UTF8: This must be passed as CHAR_AS_UTF8=1.

Example:

SERVERNODE=server1.dept.abc.corp:30015;DRIVER=/usr/sap/hdbclient/libodbcHDB.so;CHAR_AS_UTF8=1

You do not have to supply a user, password, and default database, because hana_setup prompts for those.

Enter the HANA Administrator name :

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

Enter the password for the Administrator account :

Enter the password of the Administrator.

Enter the name of the database :

Enter the name of the database that you want to contain the tables and other objects for use by SharePlex. You can enter the name of a new or existing 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 hana_setup create it for you.

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

Press Enter to accept the default to create a new SharePlex database user account and schema of the same name in the specified database, 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:

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 of the SharePlex user :

Enter the password of the SharePlex user account.

Re-enter the password for the SharePlex user :

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

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

Completed SharePlex for HANA database configuration

SharePlex User name: splex

Database name: ndb5

Target specification in SharePlex configuration: r.ndb5

Grant the required privileges to SharePlex

Before you start SharePlex replication to a HANA target, grant the following privileges to the SharePlex database user in that target (where SP_USER is the name of the SharePlex database user):

  • GRANT USER ADMIN TO sp_user;
  • GRANT TABLE ADMIN TO sp_user;
  • GRANT CATALOG READ TO sp_user;
  • GRANT DATA ADMIN TO sp_user WITH ADMIN OPTION;
  • GRANT ROLE ADMIN TO sp_user WITH ADMIN OPTION;

Additionally, log in as the owner of each schema that contains objects that you want to replicate, then make the following grants on the schema:

  • GRANT CREATE ANY ON SCHEMA schema_name TO sp_user;
  • GRANT DEBUG ON SCHEMA schema_name TO sp_user;
  • GRANT DELETE, DROP, EXECUTE, INDEX, INSERT, SELECT, UPDATE ON SCHEMA schema_name TO sp_user;

Teradata Setup (td_setup)

SharePlex Utilities > Teradata Setup (td_setup)

Overview

Run the Teradata Setup program (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 using Teradata Setup

  • 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 Teradata Setup on all target Teradata instances in the SharePlex replication configuration.
  • Within a server cluster, run Teradata Setup on the node to which the shared disk that contains the SharePlex variable-data directory is mounted.
  • For consolidated replication, run Teradata Setup for each variable-data directory on the Teradata target.

Required privileges to run Teradata Setup

Teradata Setup 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 Teradata Setup

  1. Shut down any running SharePlex processes and sp_cop on the target system.
  2. Run the td_setup utility 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 5: Teradata 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 Teradata Setup utility so that the rest of the setup can take place. It requires a second running of Teradata Setup to complete the setup steps.

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

Run Teradata Setup 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 Teradata Setup 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

Related Documents