Chat now with support
Chat mit Support

SharePlex 10.1.2 - Reference Guide

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

PostgreSQL Setup (pg_setup)

Overview

Run the Database Setup utility for Postgres (pg_setup) to establish a user account, schema, and tables for use by SharePlex.

Supported databases

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

Fujitsu Enterprise Postgres Prerequisite

Fujitsu Postgres contains a customized ODBC driver designed to run with the shared libraries supplied by Fujitsu Postgres. In order to ensure the proper configuration, you must create a symbolic link to ensure that the correct libraries are found at runtime.

Issue Description

If you attempt to run the pg_setup program prior to creating the symbolic link, pg_setup will fail with the following error message:

Error: [unixODBC]invalid connection option "target_server"

To create a symbolic link

To ensure that the proper library gets loaded, first locate the path to the directory where the Fujitsu Postgres libraries are installed (for example /opt/fsepv95server64/lib). Then create a symbolic link in the SharePlex OPTDIR/lib/hooks directory pointing to the libpq.so.5 library in the Fujitsu Postgres library directory. For example:

cd /opt/splex/lib/hooks

ln –s /opt/fsepv95server64/lib/libpq.so.5

Guidelines for use

  • Run the Database Setup utility on all target Postgres instances in the SharePlex replication configuration.
  • Within a server cluster, run the Database Setup utility on the node to which the shared disk that contains the SharePlex variable-data directory is mounted.
  • For consolidated replication, run the Database Setup utility for each variable-data directory.
  • On Windows, you must supply a DSN (data source name) as the connection method.

  • On Linux, you can provide a connection string or a DSN (data source name). Note the following when deciding on the connection method on Linux:

    Connection Type on Linux What to do
    Connection string You do not need to provide a user, password, or default database in a connection string. The connection string must have the port, server and driver defined. This is an example from EDB Postgres Plus Advanced Server; your connection string will probably be different based on your own database setup: 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

Review the following requirements to ensure that the setup succeeds.

  • The Database Setup utility must be run as a Postgres 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 utility 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, 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.

    • On Amazon RDS, you might need to grant usage/privileges on the target schema and tables to the SharePlex user, as shown in the following example:

      Log in as the schema owner, then issue the following commands:

      grant usage on schema schema_name to user_name;

      grant all privileges on all tables in schema schema_name to user_name;

Run Database Setup for PostgreSQL

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

  2. Run the pg_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> pg_setup -p9400

Table 8: Setup prompts and responses

Prompt Response

(Linux)

Enter the PostgreSQL DSN name or connection string [] :

(Windows)

Enter the PostgreSQL DSN name [] :

 Enter a DSN or a connection string if the system is Linux, or enter a DSN if the system is Windows.

Enter the PostgreSQL Administrator name :

 Enter the name of the Postgres 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 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 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

Configure SharePlex to support PostgreSQL database on Azure platform

You can configure SharePlex to support the PostgreSQL database on the Azure platform using the below steps:

  1. Add the DSN entry in the Odbc.ini file at /etc/odbc.ini and the …/var/odbc directory.
  2. Copy the /etc/odbcinst.ini file to the …/var/odbc directory.
  3. Run the PostgreSQL setup utility.
This process creates the SharePlex tables, login and user accounts needed to run SharePlex replication.
 

Table 9: Setup Prompts and Responses

Prompt Response

Enter the PostgreSQL DSN name or connection string [] :

Enter the PostgreSQL DSN name or a connection string that connects to the PostgreSQL database system.

Example:

pslazpgdb02

Is DB hosted over Azure ? :

Y

Enter the Database hostname :

Enter the Azure database host name.

Note: PGsetup Administrator name should be in the <username> format (Don't mention hostname)

Example:

pslazpgdb02.postgres.database.azure.com

If a user already exists for SharePlex then it should be entered in the <username@hostname> format.

If a new user needs to be created for SharePlex then is should be entered in the <username> format.

Enter the PostgreSQL Administrator name :

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

Example:

postgres

Enter the password for the Administrator account:

Enter the password of the Administrator.

Note: User 'postgres@pslazpgdb02.postgres.database.azure.com' got the superuser role.

Enter the replication target database name :

Enter the target database name on which replication needs to be performed.

Example:

sp_mk

Would you like to create a new SharePlex user?

Enter the name of the existing SharePlex user:

N (If you want to create a user, enter “y”)

 

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: postgres@pslazpgdb02.postgres.database.azure.com

Database name: sp_mk

The data source identifier in the SharePlex configuration is 'r.sp_mk' –

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 the db_owner role
  • 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

For supported SQL Server platforms and versions, see the SharePlex Release Notes.

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.

  • The sysadmin role is required to run mss_setup, but it is not required by the SharePlex database account used to run SharePlex replication (the SharePlex User). The db_owner role is required by the SharePlex User account and it is granted by mss_setup (for source and target).

  • (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 10: Setup prompts and responses

Prompt Response

Enter the Microsoft SQL Server DSN name [] :

Enter the 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)

The Database Setup utilities automatically configure a source or target database to allow SharePlex connections and to establish required database components that support replication.

Contents

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

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

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.

  • If SP_SYS_HOST_NAME is set to an IPV6 address on the source system, SharePlex on the target system must be version 9.0 or later.

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.
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/default.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.

 

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen