Connect CDC Installation Guide. Version 5.8

(1)

Connect CDC Installation Guide

Version 5.8

(2)

1 - Introduction

Overview...5

Installation: A Multi-step Process...5

Sample Configurations...6

Required JDBC Driver for Non-Windows Platforms...8

2 - Setup

What is Required Before Installing...10

3 - Installing on Windows

Overview...17

System Requirements...17

Preparing the Windows Environment...18

Connect CDC Install Wiz...20

4 - Installing on UNIX and Linux

Overview...37

Install Modes...38

Installer Support by Platform...38

Install Files...39

Installing...40

Running the Configurator Outside the Install Process...73

If you Run the Batch Installer...73

6 - Configurator for CyberArk installs

Overview...76

Configurator Windows...76

Running the Configurator Outside the Install Process...78

If you Run the Batch Installer...78

7 - After the Install

Overview...81

Adding the License...81

Starting Connect CDC MonCon...81

Starting Connect CDC Listener...82

Stopping Connect CDC Listener...83

Reconfiguring an Installation...84

8 - Configuring Connect Portal

Overview...86

Configuring the Connect Portal service...86

9 - Upgrading Connect CDC

(3)

10 - Uninstalling

Overview...102 Uninstalling on UNIX and Linux...102 Uninstalling on Windows...102

(4)

In this section

Overview...5

Installation: A Multi-step Process...5

Sample Configurations...6

Required JDBC Driver for Non-Windows Platforms...8

(5)

Overview

This guide contains information on installing Connect CDC on Windows, UNIX, and Linux platforms.

See the Connect CDC IBM i Install Guide for information on installing on the IBM i platform.

The Connect CDC install package includes the WinInstaller for Windows installation and JavaInstaller for Unix, Linux, and IBM i. The Docs directory includes the following PDFs:

• Install Guide (this guide)

• IBM i Install Guide

• Getting Started Guide

• Advanced User Guide

• System Reference Guide

Note: Use Adobe® Acrobat® Reader version 9.0 or above to view and print the documentation.

Click Acrobat Reader Help in the Help menu for information about using the toolbar icons to navigate documents quickly and to adjust the page display size. To download a copy of Adobe Acrobat Reader, go to:http://www.adobe.com/products/acrobat/

This chapter has sections on the following topics:

• Installation: A Multi-step Process

• Sample Configurations

Installation: A Multi-step Process

Installation consists of installing:

• Connect CDC Director on each Windows host where modeling will be done.

Connect CDC Director is the GUI modeling tool that runs on a Windows host and is used to create and maintain an Enterprise Data Movement Model (EDMM).

See Installing on Windows for information on installing Connect CDC Director on all supported platforms other than IBM i.

Introduction

(6)

• Java data movement components on each host that participates in data movement whether a source, target or intermediate host, and across database servers and hosts.

These components collect and replicate data. Connect CDC Listener runs on each host, initializes and communicates with the other data movement components on the host and with client components.

Refer to the Installing on Windows for installing the Java data movement components on Windows.

For UNIX and Linux, refer to Installing on UNIX and Linux . See the IBM i Install Guide for information on the IBM i platform.

• Java client components on each host that will monitor and control data movement.

Java client components monitor and control data movement. Connect CDC MonCon is a GUI application and may be installed on Windows and UNIX. Connect CDC Console is a command-line application and may be installed on Windows, UNIX, and Linux, described in this guide. WebMonCon is a web-based monitoring and control tool and may be installed on Windows, UNIX, Linux, or Solaris.

It may not be installed on IBM i.

See Installing on Windows to install the Java client components on Windows. For UNIX and Linux, see Installing on UNIX and Linux . See the IBM i Install Guide for information on the IBM i platform.

Sample Configurations

(7)

As described in the following sections, the location of the Connect CDC Director in your system configuration is optional.

All figures show the Connect CDC Director on a separate Windows machine. This is not required

Introduction

(8)

Director could instead reside on the Windows machine hosting the source or target. In the second figure, the Connect CDC Director could instead reside on the Windows machine hosting the source.

Required JDBC Driver for Non-Windows Platforms

Connect CDC uses JDBC for connectivity. You must obtain and install the JDBC drivers for each host and target DBMS before installing Connect CDC. The Connect CDC Release Notes lists the JDBC drivers supported for each DBMS version.

During Connect CDC install, you are asked for the location of the JDBC drivers. The JDBC drivers must be available on each host on which the Java components are installed.

2 - Setup

In this section

What is Required Before Installing...10

(10)

What is Required Before Installing

Note: Connect CDC Listener must be stopped prior to reconfiguration (seeStopping Connect CDC Listener).

Prior to installing Connect CDC on a host:

• Ensure that the file system where Connect CDC is installed has at least 1 Gigabyte of disk space.

• Database JDBC drivers must be installed on the installing host for non-Windows platforms.

• Oracle Unicode target column values replicated to the target column can be truncated because the XML length is incorrect. To avoid this issue ensure that you use the following JDBC driver versions for Unix:

• For Oracle 11g use 11.2.0.4 and above.

• For Oracle12c, 18c, or 19c use 12.0 and above.

Note the location of the JDBC drivers since they are needed during the install. Connect CDC uses JDBC for connectivity. The user is required to obtain the chosen JDBC driver. See theConnect CDC Release Notes for the current list.

• J2SE must be installed on both the installer and recipient hosts, for non-Windows platforms. See theConnect CDC Release Notes for the Java version number.

• The PATH environment variable must be set up non-Windows platforms.

• The following TCP/IP daemons must be available:

• For remote installs, the FTP server must be running on the recipient host and an FTP client must be running on the originating host where the installer is run.

• For remote installs and for installing Connect CDC Listener as a startup script, the rexec daemon must be active on the recipient host.

• The GUI Installer must have access to the tmp directory since install attempts to detect an existing install of Connect CDC on the installing host by creating a file in a well-known writeable system directory. The directory is the temporary I/O directory provided by the Java system property java.io.tmpdir. The file is either a link to the <host_name>.properties file in the host install directory,

(11)

File Type Temporary Directory

Platform

Link to <host_name>.properties /usr/tmp

UNIX

Link to <host_name>.properties /usr/tmp

Linux

License Files

You will receive a license file in an email. The initial Connect CDC install may be done without the license file. It is, however, required before you can commit a model.

1. Rename the Connect CDC license file that you received to omnilicense.

2. Save the license file to the Connect CDC Kernel subdirectory. For example:

C:\PreciselyConnect\ConnectCDCV58\kernel\omnilicense

where omnilicense is the licensing file name.

Keep in mind the following when working with license files:

• The license file has no extension.

• If you FTP the license file, you must specify that the file is binary.

• The Connect CDC Windows Install Wizard will process the license file. Refer to Connect CDC Install Wizard.

• Connect CDC automatically reminds you if your license is within 30 days of expiring. This message displays at startup and at the beginning of each subsequent day.

Database or Platform-specific setup tasks

See the following sections for setup tasks specific to a database or a platform:

• MySQL

• Informix DS

Setup

(12)

• Oracle

• Teradata

• UDB Db2

• UNIX and Linux

MySQL

If you plan to use the MySQL loader, you must specify MySQL’s bin directory in your path.

Informix DS

Note: Connect CDC does not support Informix DS databases that are created with the ANSI-compliant parameter enabled.

You must set the DELIMIDENT environment variable in the server so that DELIMIDENT=Y. This is an operating system environment setting. Set up the environment variable in the shell or using login initialization scripts.

To check environment settings, go to a shell and enter:

env

Kafka

Connect CDC ships with default Kafka and Schema Registry client library jar files that enable Kafka when Connect CDC installs. However, you can replace these jar files with different client jar files in the Connect CDC jarfiles subdirectories. For example:

• Kafka: C:\PreciselyConnect\ConnectCDCV58\jarfiles\kafka

• Schema Registry: C:\PreciselyConnect\ConnectCDCV58\jarfiles\schema-registry

Oracle

The following sections describe Oracle setup tasks.

If you plan to install and use Connect CDC in a configuration where Connect CDC Director will run on a different host than the one on which Oracle is installed, Connect CDC requires the use of the

(13)

• Shut down and restart Oracle when you create a password file.

Note: Since the Oracle DBMS must be rebooted once the password file has been created, prior planning is required to accomplish this essential step.

The database initialization parameter OPEN_CURSORS must be defined at a minimum of 50 if any Replication or Synchronization request contains a bidirectional mapping to an Oracle server. If the number is less than 50, you may receive the Oracle error message indicating you have exceeded the maximum number of cursors if you have many bidirectional mappings to an Oracle server.

Before you use the Change Selector

You must do the following setup activities before you can use the Oracle Change Selector:

• Archive mode

Running in archive mode is a requirement for replication. If archive mode is not enabled during startup, the Change Selector issues an error and shuts down.

Additionally, the automatic archival option must be enabled by setting log_archive_start = TRUE in the Oracle parameter file and restarting the database. Connect CDC cannot do this automatically because Oracle does not provide a way to do this programmatically.

Note: These parameters reside in SPFILES. For more information refer to http://www.orafaq.com/wiki/SPFILE

• Storage requirements

The log-based changed data capture requires supplemental logging. Extra storage may be required for supplemental logging depending on a number of factors such as, the number of tables being replicated, the number of columns replicated within those tables, the size of the rows within the table and the overall volume of updates against replicated tables.

The best practice is to monitor the actions on the tables and to determine if the database continually requests more archive space. If so, then storage must be increased.

What happens to the redo logs Statement

No additional information is written to the redo logs.

Inserts

Setup

(14)

What happens to the redo logs Statement

Additional information, which includes the old column for all replicated columns, is written to the redo logs. Without supplemental logging, normally only the old values for the key columns are written to the redo log.

As a result of this additional information in the redo logs, more archive logs may be generated. These archive logs must be kept until they are no longer needed for replication and have been saved for backup.

Deletes

Additional information, which includes the old column for all replicated columns, is written to the redo logs. Without supplemental logging, normally only the old values for the key columns are written to the redo log.

As a result of this additional information in the redo logs, more archive logs may be generated. These archive logs must be kept until they are no longer needed for replication and have been saved for backup.

Updates

• Privileges

• If you plan to retain archive logs (see step 5), the user who starts the kernel must have the privileges to create files in the primary Oracle archive destination directory.

This privilege is only required when you specify that you want to retain archive logs, as specified for the Oracle parameters during the install. For each processed archive log, Connect CDC creates an empty file using the same archive name with the “.repdone” suffix appended to the name as a means to determine which logs Connect CDC has processed. These logs can thus be backed up and deleted.

• The user who is to use “Delete unneeded archive logs” (see step 5) needs delete privileges on Oracle’s archive log files.

When delete archive logs is specified Connect CDC does not create the empty files. However the user must have the privileges to delete the archive log files.

• If you plan to use Oracle’s fast loader, you must specify Oracle’s bin directory in your path. For

(15)

• The Communication processor hostid must be specified if one has defined a copy/load request in one of the distributions defined for this server. The COP hostid is required for a load request because a load request uses the Teradata MultiLoad utility which requests this special hostid name in order to make a connection to the server. See the Teradata Tools and Utilities Installation Guide for information on how the COP hostid is defined. One needs to define a special entry in the “hosts”

file.

UDB Db2

This section lists UDB Db2 setup tasks.

You must set up UDB Db2 with archive logging, not circular logging when Db2 is used as a source in replication.

Environment variables must be set up before starting an install. These variables will be used on the install UDB Db2 & JDBC driver parameters window described in Running the GUI Installer.

• Path for the UDB DB2 library

The variable is either LIBPATH for AIX or LD_LIBRARY_PATH for Linux, for example:

LIBPATH=/home/db2instl/sqllib/lib

Set this variable to the home directory of the UDB Db2 install.

• For local installs, set the DB2INSTANCE name, for example:

DB2INSTANCE=db2instl

• If you are installing UDB Db2 on Solaris (target-only install allowed), set the LD_LIBRARY_PATH prior to install:

LD_LIBRARY_PATH=$DB2HOME/sqllib/lib

UNIX and Linux

This section lists UNIX and Linux setup tasks.

• Although a super user is required to install Connect CDC Listener as a startup script on UNIX, it is best not to install Connect CDC as a super user (see Uninstalling on UNIX and Linux).

Setup

(16)

Windows

In this section

Overview...17

System Requirements...17

Preparing the Windows Environment...18

Connect CDC Install Wiz...20

(17)

Overview

The following list outlines the main steps for installing the Connect CDC components for a Windows database source.

1. Prepare your Windows environment (See Preparing the Windows Environment) and DBMS.

2. Run the Connect CDC Install Wizard (See Connect CDC Install Wizard), which installs any or all of the following:

• Connect CDC Director

• Java components

3. Verify Connect CDC Listener is running. (See Starting Connect CDC Listener for more information.)

4. Bring up Connect CDC Director and create a simple model. See the Connect CDC Getting Started Guide for more information.

System Requirements

Please review the list of supported operating systems and databases in the Connect CDC Release Notes to determine if your configuration is supported. In general, for Windows database sources, requirements include:

• Intel machines with at least 2 GB memory.

• TCP/IP

• Supported DBMS (versions listed in the Connect CDC Release Notes)

• Minimum disk space:

• Connect CDC Director, 300 MB

• Connect CDC metabase, 40 MB for Microsoft SQL Server, Sybase, Db2, or Oracle

• Refer to the Connect CDC Release Notes for details for supported operating systems.

Note: Refer to Preparing the Windows Environment for information on setting Administrator Installing on Windows

(18)

Preparing the Windows Environment

If Java components and your database server reside on the same host machine, prepare your Windows system as follows. You may need the assistance of a system administrator.

Keep in mind the following considerations when working with Windows 7, Windows 8, and Windows 10:

• Connect CDC does not support databases running on Windows 7, Windows 8, and Windows 10.

Consequently, a Listener is not supported on Windows 7, Windows 8, and Windows 10; Windows 7, Windows 8, and Windows 10 only supports Director, MonCon and Jetty console.

• The user logged into a Windows 7, Windows 8, or Windows 10 operating system must have Administrator privileges to work with Connect CDC. Use one of the methods described below to set Administrator privileges:

Method 1 (recommended solution): Right-click on the Director, MonCon, or Jetty scripts and select Run as administrator.

Method 2: Install Connect CDC in a folder other than Program Files, Program Files (x86) or windows/system32. Even if you install Connect CDC in a folder other than Program Files, Program Files (x86) or windows/system32, if you are using WebMonCon, you must also right-click on the Jetty script and select Run as administrator.

Method 3: From the Control Panel, select User Accounts>System and Security>Change User Account Control Settings. The User Account Control Settings dialog box displays.

• Drag the side bar down to Never notify.

• Reboot your system.

(19)

Install Service Packs

Make sure the latest Windows service pack is installed.

Make Windows User Accounts Available

The following Windows user accounts must be available. Depending on your system configuration and security restrictions, a single account may satisfy all of these requirements:

• For the install, establish a user able to log in locally (not from or through a domain) as a member of the Windows Administrators group on each machine on which you install Connect CDC software.

This user must have the Windows User right to access this computer from the network.

• For the install and later, establish a Windows service account on the machine that hosts the Connect CDC process(es). This is the account under which the service runs: the Log On As start-up parameter value on the Services dialog box accessed from the Windows Start>Control Panel>Administrative Tools>Services.

You can specify this account during the install as a “system account” or you can specify a particular user account. A system account is recommended.

If this is a user account, it may be the same account used to install the service from the Connect CDC Director machine, or it may be a local or a domain account. It must have:

• Windows User Rights that include the advanced right Logon as a service on that machine

• Sufficient privileges to create and update files in the directory that contain the Connect CDC process executable files

Set Database Users

For each database, when adding, updating, or deleting rows on the source table, be sure you are not using the replication user ID to make these changes. Change capture ignores changes made by the replication user.

See the Connect CDC Getting Started Guide for how the replication user ID is defined and used in the model.

Installing on Windows

(20)

Connect CDC Install Wiz

Overview of the Connect CDC Windows Install Wizard

The Connect CDC Windows Install wizard installs the product onto your local machine, which can be a fresh install (no other version of the product currently installed) or an upgrade (previous version of the product is currently installed). The installer will also enable you to modify which components are installed, Repair any missing or corrupted components, or uninstall the product completely. The Connect CDC Install wizard performs all information gathering and configuration internally and will no longer require external Java UI configuration utilities.

The Connect CDC Windows Install Wizard enables you to:

• Configure JDBC and listener settings. The PreSetup Java UI utility is no longer required.

• Select databases and their versions.

• Detect JDBC drivers for the supported databases that are selected.

• Installs the JDBC drivers for the supported databases that are selected.

• Specify a port value for Connect CDC Listener V5.8 service.

• Verify Listener port values for availability.

• Install java JDK/JRE 8

• Create and write status messages (informational, warning, and error) to a log file

(ConnectCDCInst.log). The installer creates a log file, named ConnectCDCInst.log. This file will be created in your Temp directory, usually found as the value of the %temp% environment variable.

• Install a license file.

• Configure Oracle DB server parameters.

The Connect CDC Install Wizard, installs:

• Connect CDC Director on your local Windows host machine where modeling will be done.

(21)

• WebMonCon. Web-based monitoring and control tool.

Running the Install Wizard

The Install Wizard installs Connect CDC Director, and the Connect CDC Java components and supporting applications on your Windows machine.

1. Download the Connect CDC install package and run the WinInstaller setup.exe file to install on your local Windows machine.

The Connect CDC Install Wizard runs and displays the Connect CDC Welcome screen.

2. Click Next.

The license agreement screen displays.

(22)

3. Click Yes to accept the License Agreement.

The Choose Destination Location screen displays. It enables you to change the Connect CDC install directory.

(23)

4. Enter the Connect CDC install directory. To change the directory, click Browse and select or type an alternate directory location.

5. Click Next.

The License File screen displays.

(24)

6. Do one of the following:

a. If you have received a license key file for the product, browse to, or enter its location and specify the name of the file.

b. Select No, do not install the license file at this time. This is the default.

7. Click Next.

The Select components screen displays.

(25)

8. Select the components to install in any combination on your machine.

9. Click Next.

The OS400 install properties screen displays.

(26)

10. Click Next to treat the binary FOR BIT data values as characters on OS400 hosts.

The Select Databases screen displays. This screen enables you to select which databases will be used with the product. This screen only displays if the Data Movement Kernel is selected to be installed with the product.

(27)

11. If you select Microsoft SQL Server database and intend to create a new remote MS SQL server:

• Use the Connect CDC Install Wizard to install the appropriate JDBC drivers. The JDBC drivers are required to access the remote instance of MS SQL Server. This must be done even if MS SQL Server is not installed on the remote host. Configure MS SQL Server during the install of the software on the remote host windows machine. Specifically, configure MS SQL Server to install the appropriate JDBC drivers for MS SQL Server on the remote host. For more

information, refer to the section, “Create a New MS SQL Server” in Chapter 2, Defining a Model, of the Getting Started Guide.

• You must install additional software to use the BCP utility for remote loading. Download and install the “Microsoft Command Line Utilities” software package that includes the BCP utility.

This software is not provided by the Connect CDC install program. The “Microsoft Command Line Utilities” software package must be installed on the remote host machine that is applying the data to the remote MS SQL Server instance. Refer to the “Microsoft Command Line Utilities 11 for SQL Server” website for more information.

12. Click Next.The Required Startup options screen displays. Proceed step 20.

13. If you select an Oracle database and intend to create a new remote Oracle server, you must install the appropriate JDBC drivers. The JDBC driver is required to access the remote instance of Oracle. This must be done even if Oracle is not installed on the remote host. For Windows you can use the Connect CDC Install Wizard to install the appropriate JDBC drivers. For Linux and Unix you must manually download the JDBC drivers. For more information, refer to Installing

(28)

on UNIX and Linux . You can also refer to the section, “Create a New Oracle Server” in Chapter 2, Defining a Model, of the Getting Started Guide.

14. Click Next.The Required Startup options screen displays. Proceed to step 20.

15. If you select Teradata and click Next, the Required Startup options screen displays. Proceed to step 20.

16. If you select a Db2 database, and click Next, the Db2 Path Configuration screen displays. Proceed to step 17. If you select any of the other databases, and click Next, the Required Startup options screen displays. Proceed to step 20.

17. Enter or browse to the Db2 Bin Path and the Db2 JDBC Driver Path.

Note: The installer will attempt to populate the values from the registry if Db2 is installed.

18. If you select a Db2 for z/OS database and click Next, the Db2 for z/OS Path Configuration screen displays. Enter or browse to the Db2 for z/OS JDBC Driver Path.

19. Click Next.

The Select Streaming Platforms screen displays.

(29)

20. Click Next.

The Select Data Warehouse Platforms dialog displays.

(30)

21. If you plan to apply data changes to a Snowflake target, select Snowflake as your data warehouse, then click Next.

The Required Startup options dialog displays.

Enter the minimum and maximum amounts of memory, in megabytes, that can be allocated to the kernel. We recommend that the maximum allocation be equal to the minimum allocation for performance efficiency. 1024MB is the default minimum and maximum value. You can change these values, but lower values may impact performance and higher values are subject to the memory limit on the machine where Connect CDC runs.

If port 51701 is already in use, enter another port number, for example, 12345 or 54321.

Verification of the Connect CDC Listener port must succeed; if it does not, the install fails.

Note: The memory configuration is subject to change depending on the size of your model and data volume.

22. Click Next

The Advanced Listener startup options window displays.

(31)

23. Set the Encryption option for Connect CDC Listener communications. Select Use encrypted communications to enforce authenticated and encrypted communications.

These settings apply to the Connect CDC Listener. The host definition in the Enterprise Data Movement Model (EDMM) must use the same encryption setting as was defined for Connect CDC Listener.

24. Click Next.

The installer displays the Credential Manager Option dialog.

(32)

25. Click Select to use CyberArk to manage security credentials.

By default, no Credential Management option is selected.

26. Click Next.

The Select program folder dialog displays.

27. Enter the name of the folder into which the Connect CDC icons and shortcuts are installed, then click Next.

The Start copying files window displays. It lists the Connect CDC components that will be installed.

Click Back to navigate to any screen and re-select options or components.

(33)

28. Click Next to start the install.

The Setup Status window indicates the progress of the install.

As the install completes, the Setup Status window displays.

(34)

Once the install completes the InstallShield Wizard Complete screen displays. Click Finish to exit the wizard.

(35)

Note: If you chose to install on a server with an Oracle database, additional windows prompt you for Oracle log parameters. See Configurator for Oracle Installs.

Note: If you chose to connect to CyberArk to manage security credentials, an additional windows prompts you for CyberArk connection parameters. See Configurator for CyberArk installs.

29. Click Finish to complete the install.

(36)

and Linux

In this section

Overview...37 Install Modes...38 Installer Support by Platform...38 Install Files...39 Installing...40

(37)

Overview

The Java Installer installs Connect CDC on UNIX, Linux, and IBM i platforms. See the Connect CDC IBM i Installation Guide for IBM i install procedures.

The topics in this section are:

• Install Modes

• Installer Support by Platform

• Install Files

• Installing

• Running the GUI Installer

• Running the Batch Installer

• binstaller.cmd

The install procedure does the following:

1. Gathers input describing where to install and information about the host environment.

2. Verifies information gathered in Step 1 before copying any Connect CDC files:

• The version of the Java Run-time Environment must be at a level acceptable for the Connect CDC executable processes.

• The Java compiler should be available wherever Connect CDC is installed.

You receive a warning if the javac file is not available. The install can continue without javac, but expressions and join tables will not function.

• The TCP/IP port number chosen for use by the Connect CDC Listener V5.8 must be available and not used or reserved by any other service.

3. Configures shell scripts using input gathered in Step 1.

4. Installs the files.

This involves copying components from the source location to the user-chosen target directory on the host.

5. On UNIX and Linux platforms, configures the host so that Connect CDC Listener starts at host boot or IPL. This is an optional feature; the user can choose to do this or not.

Installing on UNIX and Linux

(38)

7. Saves the install configuration. This step creates a properties file in the target install directory with the file name of the host being installed and a file extension of ini. This file contains the parameters values chosen for this host install. Along with the log file created during the install, this file serves as a record of the install. Subsequent runs of the Installer attempt to locate this file.

Install Modes

The install may be a full install or a reconfiguration of an existing install. The install may be local or remote, and may be done in batch or interactive mode.

• Full or Reconfiguration

• Full install is a complete install of all files.

• Once Connect CDC has been installed, Reconfiguration is offered as a choice for changing all parameters except the install directory and the host where it is installed.

• Local or Remote

There are two types of hosts during an install. The originating host runs the installer program. The recipient host is the machine on which Connect CDC is being installed.

• A local install runs the Installer on the originating host and installs Connect CDC on the same host.

In this case, the originating host and recipient host are the same.

• A remote install runs the installer on the originating host but installs Connect CDC onto a different host. The Java Installer may run on a Windows or UNIX host and install on a UNIX, Linux, or IBM i host (see the IBM i Install Guide). The TCP/IP server daemons, FTP and SSH, must be running on the installing host.

• Interactive GUI or Batch Installer

Connect CDC may be installed via a GUI Installer or a Batch Installer.

• Java 8 or higher is required to be installed on the remote system.

(39)

Install Connect CDC Remotely Install Connect CDC Locally

OperatingSystem

From another UNIX or Linux host or a Windows host, use either the GUI Installer or the Batch Installer.

Use the GUI Installer or the Batch Installer.

UNIX

From another UNIX host or a Windows, use either the GUI Installer or the Batch Installer.

Use the GUI Installer or the Batch Installer.

Linux

Install Files

The install files, listed below, are packaged together in one file, named install.zip. To list the contents of install.zip without unpacking, enter the following command:

jar tvf install.zip

Description File

.bat file that runs the Batch Installer on Windows binstaller.cmd

Shell script that runs the Batch Installer on UNIX or Linux binstaller.sh

.bat file that runs the GUI Installer on Windows ginstaller.cmd

Shell script that runs the GUI Installer on UNIX or Linux ginstaller.sh

Library, provided by jScape, required for install networking tasks and for installing the Connect CDC Listener start and kill scripts in the boot area

inetfactory.jar

(40)

Description File

Java Installer program for both the GUI and Batch Installer programs

installer.jar

Java HTTP Server and Servlet Container, necessary to run WebMonCon, packaged into a zip file.

jetty.zip

Library used for SSH secure connections jsch-0.1.54.jar

Library from IBM required for FTP install tasks and running Connect CDC after it is installed. Contains the IBM i JDBC driver.

jt400.jar

File used to enable remote hosting.

JT400offbox.properties

File used to enable FOR BIT DATA (IBM i Only) translation to treat binary data values as character values

JTOpen400.properties

Library used for writing messages to an install log log4j-1.2.8. jar

Connect CDC packaged into a zip file omni.zip

Files containing UDB Change Selector udbcs.zip

Installing

(41)

2. Unpack the install files (listed above) on the installing host. The command to unpack depends on the platform of the originating host.

• On a UNIX platform, issue the command:

jar xvf install.zip

The Installer does not work correctly if the following characters are used in any UNIX file or directory names processed by the Installer:

| )

(

\

; blank space

<

&

$

#

!

@

^ }

{

*

?

>

' single quote

“double quote new line character

tab character

• On a Windows platform, use WinZipÒ or another similar program or the following command:

jar xvf install.zip

3. Run the GUI or Batch Installer (see Running the GUI Installer or Running the Batch Installer).

Note: The GUI installer does not support install Kafka and Db2 for z/OS installs. Use the batch installer to connect to Kafka or Db2 for z/OS.

Running the GUI Installer

The GUI Installer may perform the install on the following:

• Local host running UNIX or Linux.

• Remote machine running UNIX and Linux, where the local machine runs UNIX, Linux, or Windows.

When the originating host is UNIX, run the GUI installer with the command:

(42)

When the originating host is Windows, run the command:

ginstaller.cmd

The GUI Installer may be used to perform an initial full install of Connect CDC, or a reconfiguration of an existing install. During a reconfiguration, any value may be changed, even though the values fill in with information from the previous install.

Note the following:

• Before doing a reconfiguration, shut down Connect CDC Listener (see Stopping Connect CDC Listener).

• If you are upgrading, you should recommit your model when you finish the install to take advantage of the latest features of the new release.

Note: Description of the GUI windows and the information requested for installing Connect CDC follow. The appearance of the window varies slightly depending on the platform.

Using the GUI Installer to Install Connect CDC

1. Start the GUI Installer

When the originating host is UNIX, run the GUI installer with the command:

sh ginstaller.sh

When the originating host is Windows, run the command:

ginstaller.cmd

The Welcome window has the fields in which you set constants for the operating system. The operating system that you select affects what options are included on subsequent windows.

(43)

Description Field

Enter a host name.

• Enter the name of the local machine on which you are installing.

• For remote install, enter the name or IP address of the remote host.

Host

Defaults to the operating system on the local machine.

Select the operating system type that matches the installing host machine.

Operating System

(44)

Description Field

(Linux and UNIX recipient hosts only--this option is not available for other operating systems.)

Enter the root password if you want the Connect CDC Listener automatically started when the host reboots. The start and stop scripts are installed.

Leave the password blank when you do not want the startup scripts installed on a Linux or UNIX host.

Note: If the scripts to start Connect CDC Listener are not installed during installation, for example if the install is interrupted, they may be manually copied from their location in the kernel directory.

Root Password

(Remote installs only) Enter the userid for logging on to the remote host.

User ID

(Remote installs only) Enter the password for logging on to the remote hosts.

User Password

2. Click Next

The License Agreement screen displays.

(45)

3. Read and accept the license agreement:

The Java Path screen displays.

4. Enter the path where the Java program is located.

Notes:

• For the Java installer, all paths specified during the install should use the forward slash (for example, /usr/java8_64/bin/).

• The Java path you specify should also be part of the user ID PATH environment setting.

5. Click Next.

The install Target screen displays.

6. Identify the directory where Connect CDC is to be installed. If installing remotely, the directory must be accessible to the remote host.

(46)

Note: When reconfiguring, the destination folder fills in with whatever was set during the previous install or reconfiguration.

7. Click Next to display the AS400 Offbox install and Translate Binary Data Values Option window displays.

(47)

8. Click Next to treat the binary FOR BIT data binary values as characters (if selected) on AS400 hosts.

The Installation Components Selection window displays.

9. Select the Connect CDC components to be installed. A target-only install is for IBM i or Teradata databases. In this case, the change selector is not installed on the target. The option to install Jetty is grayed out if you are installing on IBM i.

10. Click Next to display the Database Selection window.

For UNIX, the following window is displayed:

(48)

For Linux, the following window is displayed:

(49)

Note: When reconfiguring, the selected database types are set according to those chosen in the previous install.

12. If you select Oracle, the Oracle JDBC Driver Information window displays. In this window, Provide Oracle JDBC driver information based on the version number.

Note: If you select Oracle and wish to create a new remote server for Oracle, you must install the appropriate JDBC drivers. The JDBC driver is required to access the remote instance of Oracle. This must be done even if Oracle is not installed on the remote host.

For Windows you can use the Connect CDC Install Wizard to install the appropriate JDBC drivers. For Linux and Unix you must manually download the JDBC drivers. For more information, refer to the section, “Create a New Remote Oracle Server” in Chapter 2, Defining a Model, of the Getting Started Guide.

Specify the path for the JDBC driver directory for the appropriate Oracle versions, for example for Oracle

12c:/export/home/app/oracle/product/12.2.0/dbhome_1/jdbc

Click Next.

13. If you select UDB, the UDB JDBC Driver Information window displays. Use this window to set the UDB JDBC driver information based on the version number. You can use this information to validate the appropriate driver based on Db2 and Java version.

(50)

Note: The JDBC driver directory should have been installed and the path set up and the DB2 instance name defined before the install. If you have not set these up, cancel and see the setup requirements for UDB Db2.

Specify the following information:

• Location for the JDBC driver directory, for example :/common/users/dvtim/js23-32/v540/jdbc

• Path for the DB2 library, for example:

/jdbx/UDB95/db2inst/sqllib/lib64

• DB2 instance name, for example:db2instl Click Next.

14. If you select SQL Server, the SQL Server JDBC Driver Information window displays. (Linux only.) Specify the full path to where the SQL Server JDBC driver is located.

(51)

• Download and install the SQL Server command-line mssql-tools for Linux.

• mssql-tools include the sqlcmd command-line query utility and the bulk copy program (BCP) utility for remote loading to the target.

• The mssql-tools must be installed on the remote host machine that is applying the data to the remote SQL Server instance.

• After you install the utilities, append the BCP location to the PATH environment setting of the user running the kernel.

• This software is not provided by the Connect CDC install program. To download the utilities, see the “Install SQL Server tools” webpage of the “SQL Server on Linux” Microsoft online documentation.

Note: For information about creating a remote server, see the section, “Create a New MS SQL Server” in Connect CDC Getting Started Guide.

15. For other selections, set the path for the JDBC driver in the displayed windows. The JDBC drivers depend on:

a. The operating system chosen in the initial Welcome window b. Database types selected for participation in data movement

The Browse button appears only if you are installing locally. Select the directory where the driver is installed. If installing remotely, the directory must be accessible to the remote host.

Note: When reconfiguring, the driver path contains the value provided in the previous install or reconfiguration.

What to do...

DatabaseType

Specify the full path to where the JDBC driver file is located, and click Next. You will see this window only if you selected Informix as a database type installed on this recipient.

Informix

Specify the full path to where the MySQL Connector/JDBC driver is located, and click Next.

You will see this window only if you selected MySQL as a database type installed on this recipient host.

MySQL (Linux only)

(52)

What to do...

DatabaseType

Specify the full path to where the PostgreSQL JDBC driver was installed, then click Next. You will see this window only if you selected PostgreSQL as the database type installed on this recipient host.

PostgreSQL

Specify the full path to where the jconn4.jar file is located. Click Next. You will see this window only if you selected Sybase as a database type installed on this recipient host.

Sybase (UNIX only)

Specify the full path to where the Teradata JDBC driver was installed, then click Next. You will see this window only if you selected Teradata as the database type installed on this recipient host.

Teradata

16. Click Next to display the Listener Port window.

(53)

If the port number is not found in the /etc/services file, it listens on the port to determine if it is currently in use. The installer assumes the port is free if the port is not active.

Note: When reconfiguring, the port number contains the value specified in the previous install or reconfiguration. When reconfiguring an install, Connect CDC Listener must be shut down prior to installing or the Installer assumes the port is in use by another service (see Stopping Connect CDC Listener).

18. Click Next to display the JVM Memory Specifications window.

19. Specify the minimum and maximum amounts of memory, in megabytes, to use for data movement.

We recommend that the maximum allocation be equal to the minimum allocation for performance efficiency. 1024MB is the default minimum and maximum value. You can change these values, but lower values may impact performance and higher values are subject to the memory limit on the machine where Connect CDC runs.

If reconfiguring, the memory minimum and maximum parameters contain the values specified in the previous install or reconfiguration.

20. Click Next to display the Encryption options window.

(54)

21. Select the Use encrypted communications option to use encryption in all communications with the recipient host.

When reconfiguring, the Use encrypted communications option is selected since it was chosen in the previous install or reconfiguration.

22. Click Next to display the Summary of Selections window which lists the selected install parameters.

(55)

23. Do one of the following:

• Click Install, to initiate the install.

• If incorrect, click Back and make changes.

• Click cancel, to exit the Install Wizard.

Note: If you are installing on a server with an Oracle database, additional windows prompt you for Oracle log parameters (see Configurator for Oracle Installs).

24. Click OK once the install has completed successfully.

A final window displaying the install results displays.

Note: The sample shows an Oracle where the DBMS is Oracle so the window includes a Next button that opens the Configurator (see Configurator for Oracle Installs).

25. Click Finish to finish the install.

Running the Batch Installer

The Batch Installer may perform the install on a local host running UNIX and Linux. The Batch Installer may perform the install on a remote machine running UNIX and Linux and the local machine is UNIX or Windows.

(56)

The Batch Installer may be used to perform an initial full install of Connect CDC or a reconfiguration of an existing install.

Note: Before doing a reconfiguration, shut down Connect CDC Listener (see Stopping Connect CDC Listener).

Batch installer Steps

To run the batch installer, do the following, as described in the associated sub-section:

1. Create the host.list file containing entries for installing to one or more hosts (see Create the host.list File).

2. Create the <host_name>.properties file for each host listed in the host.list file where HOSTNAME is the name of the host machine to install Connect CDC (see Create the

<host_name>.properties File).

3. Run the batch installer (see Run the Batch Installer).

4. If you are installing on a server using Oracle, create the config. properties file. For more information, see If you Run the Batch Installer.

Create the host.list File

The host.list file identifies one or more hosts on which to install Connect CDC. It must be located in the current directory where the Installer is running. Below is a sample host.list file:

remote=Nreconfigure=Nvector=UNIXremote=Yreconfigure=Ymountain=UNIX

This example asks the Batch Installer to install on two hosts:

• A local, initial full install onto the UNIX host named vector

• A remote, reconfigure install onto the UNIX host named mountain

Keywords and input parameters may be in mixed case. The order of the input parameters is important.

Comments are denoted by a # in the first column of a line. Comments are not allowed on the right side of a key=value property specification.

(57)

Description Keyword or InputParameter

One of the following:

• N is the default. N indicates the install will occur locally where the Installer program is running.

• Y indicates the Installer program will install on a different host than where the installer is running. The originating host is a different host machine than the recipient host.

This remote keyword affects all installing hosts defined later in the host.list file until another remote keyword is specified.

Remote

One of the following:

• N is the default. N indicates the installer must perform a full install of Connect CDC.

• Y indicates that hosts have an existing Connect CDC install and should be reconfigured.

This reconfigure keyword affects all hosts defined later in the host.list file until another reconfigure keyword is specified.

Reconfigure

Defines host (recipient host) on which to install Connect CDC.

• host_filename–Identifies the properties file containing the install parameters for installing to one host. host_filename plus.properties comprises the properties filename.

In the example above, there would be two property files names named vector.properties and mountain.properties.

• HOST_TYPE–The operating system type of the recipient host. The valid operating system type is UNIX. (Use UNIX for Linux.)

host_filename = HOST_TYPE

(58)

Create the <host_name>.properties File

Define a separate .properties file for each host listed in the host.list file. Each .properties file must be located in the current directory where the installer is running. Below is a sample.properties file named mountain.properties for the host named mountain:

# Sample UNIX install parameters file

# HOST_NAME is the name of the UNIX host to install HOST_NAME=mountain

HOST_USER=rpuser HOST_PASS=rpuser

JAVA_PATH=/usr/java/bin

INSTALL_CD=/common/users/rpuser/PreciselyConnect

INSTALL_DIRECTORY=/common/users/rpuser/PreciselyConnect/Conne ctCDCV58

LISTENER_PORT=1780 INITIAL_MEMORY=256 MAXIMUM_MEMORY=256 SSL_ENCR=N

INSTALL_CLIENT=Y NUM_DRIVERS=3

DRIVER_CLASSPATH_1=/common/jdbc/v405/classes DRIVER_ID_2=Sybase

DRIVER_CLASSPATH_2=/common/sybase15/jConnect-7_0/classes DRIVER_ID_3=Kafka

DRIVER_CLASSPATH_3=

ROOT_PASS=open_sesame INSTALL_JETTY = Y TRANSLATE_BINARY = N TARGET_ONLY = N

CRED_REPO_SERVICE_URL=services-uscentral.skytap.com CRED_REPO_KEY_STORE_PASS=

CRED_REPO_KEY_CERT_ALIAS=myCert CRED_REPO_KEY_CERT_FILE=

/common/users/giuntam/CYBERARK/oracyberark.jks CRED_REPO_TRUST_STORE_PASS=

CRED_REPO_TRUST_STORE_FILE=/

common/users/giuntam/CYBERARK/trust.jks

The following lists the host.name keyword descriptions for all platforms.

Description Keyword

(59)

Description Keyword

Name of the remote user on the host that “owns” the install.

Required only for remote installs.

The parameters HOST_USER and HOST_PASS are only needed if the install is remote. This user does the remote connect and should own the directory where Connect CDC is being installed or should have permission to write to this directory.

HOST_USER

Password associated with HOST_USER.

Required only for remote installs.

Leave blank or enter <PROMPT> if you prefer to be prompted rather than save your password in a file.

HOST_PASS

Directory where the Java executables are located on the recipient host. JAVA_PATH is required when installing to a remote host and when installing the Connect CDC Listener script as a host startup script on UNIX.

JAVA_PATH

Directory location of the omni.zip install file.

The Installer requires the current working directory to be writable.

INSTALL_CD

Directory on the installing host where Connect CDC will be installed.

INSTALL_DIRECTORY

TCP/IP port number to be reserved for Connect CDC Listener. Enter NONE if the installer is to skip installing the data movement kernel and Connect CDC Listener.

LISTENER_PORT

Initial memory setting of the Java heap memory.

Specify a number; megabytes are assumed. If 0 is specified, then no argument (-Xms) is constructed and passed to Java and Java’s default is used.

INITIAL_MEMORY

(60)

Description Keyword

Maximum size of the Java heap memory.

Specify a number; megabytes are assumed. If 0 is specified, then no argument (-Xmx) is constructed and passed to Java and Java’s default is used. Note that MAXIMUM_MEMORY should be greater than or equal to initial memory.

The recommendation is that MAXIMUM_MEMORY and INITIAL_MEMORY should be the same.

MAXIMUM_MEMORY

Flag of either “Y” or “N” that indicates whether SSL/TLS encryption is to be used. A “Y” value means that –Dssle will be passed to Connect CDC Listener. The cipher suites used in the encryption conform to the TLS 1.2 standard.

SSL_ENCR

Flag of either Y for yes or N for No, indicating whether to install the Connect CDC Console and Connect CDC Console tools.

INSTALL_CLIENT

Number of JDBC drivers to make accessible to Connect CDC Listener and other Java components. For each driver, a DRIVER_ID_n and DRIVER_CLASSPATH_n must be specified.

For example, if NUM_DRIVERS = 2, define the first driver with DRIVER_ID_1 and DRIVER_CLASSPATH_1. Define the 2nd driver with DRIVER_ID_2 and

DRIVER_CLASSPATH_2.

NUM_DRIVERS

(61)

Description Keyword

Where n is a number from 1 to NUM_DRIVERS.

Value is the type of driver. Must be one of the following:

• Db2ZOS

• Informix

• JTOpen400

• Kafka

• MySQL

• Oracle11g

• Oracle12c (used for Oracle12c, Oracle18c, and Oracle19c)

• PostgreSQL

• SQLServer

• Sybase3 (looks for driver jconn4.jar)

• Teradata14

• Teradata15

• Teradata16

• Teradata17

• UDBType4 DRIVER_ID_n

Value is a directory path where this driver is located on the installing host.

Note: Be sure to use forward slashes as the file separator character. Do not use the back slash even if installing from a Windows host.

For DRIVER_ID_n = Kafka driver, if the

DRIVER_CLASSPATH_n value is empty, Connect CDC installs Kafka library jars shipped with the product.

DRIVER_CLASSPATH_n

(62)

Description Keyword

(Linux and UNIX recipient hosts only--this option is not available for other operating systems.) Enter the root password if you would like the Connect CDC

Listener automatically started when the host reboots. the start and kill scripts are installed.

Leave the password blank when you do not want the startup scripts installed on a Linux or UNIX host.

ROOT_PASS

Flag of either Y for yes or N for No, indicating whether to install Jetty server on the host. Enter N for IBM i (ignored if you enter Y).

Note: Use only if INSTALL_CLIENT is set Y for yes.

INSTALL_JETTY

The default value for the SSH port is 22. If a different port is required, specify a positive number. Cannot be empty, null, or unknown.

Note: Used for remote installs only.

SSHD_PORT

Flag of either Y for yes or N for No, indicating whether to treat for bit binary data on IBM i as char.

Note: Specify N unless you have been given special instructions by your support/customer service representative.

TRANSLATE_BINARY

If Y for yes, an external change selector components will NOT be installed on the host (IBM i).

TARGET_ONLY

Domain name of the CyberArk Enterprise Password Vault service. The protocol prefix (https://) is optional because Connect CDC only connects to CyberArk over a TLS-secured connection.

CRED_REPO_SERVICE_URL

(63)

Description Keyword

Optional password for a key store file containing the client certificate required to connect to CyberArk.

If the parameter value is blank and the key store file is password-protected, the install prompts you for a key store password.

CRED_REPO_KEY_STORE_PASS

Name of the entry in the key store file that identifies client certificate required to connect to CyberArk.

CRED_REPO_KEY_CERT_ALIAS

Path and file name for the key store file containing the credentials Connect CDC sends to CyberArk for authentication during SSL/TLS handshake.

CRED_REPO_KEY_CERT_FILE

Optional password for a trust store file containing the public certificate required to connect to CyberArk.

If the parameter value is blank and the trust store file is password-protected, the install prompts you for a trust store password.

CRED_REPO_TRUST_STORE_PASS

Path and file name for the trust store file containing credentials Connect CDC uses to validate connections to trusted CyberArk servers during SSL/TLS handshake.

CRED_REPO_TRUST_STORE_FILE

The following lists the host.name keyword descriptions for Unix and Linux.

Description Keyword

Specify a root password if the installer should install the scripts to start Connect CDC Listener automatically when the host reboots:

• ROOT_PASS= value

• ROOT_PASS=<prompt>

(See Starting Connect CDC Listener for more information.) ROOT_PASS

(64)

Note: HOST_USER and HOST_PASS are also required when the root ‘password is specified.

The following lists the host.name keyword descriptions for Db2 LINUX and UNIX.

Description Keyword

Path where the Db2 library files required by the Db2 JDBC driver are installed. For example:

Note: For local GUI installs, this environment variable must be set before starting the install.

LIBPATH

Name of Db2 database instance.

Note: For local GUI installs, this environment variable must be set before starting the install.

DB2INSTANCE

Supported DBMS version levels are 9, 10 or 11.

DBMSVERSION

Path where the Db2 driver files are installed. For example:

DRIVER_CLASSPATH_n

• For Db2 UNIX

If DBMSVERSION=9Then DRIVER_ID_n = UDBType4

• For Db2 LINUX

DRIVER_ID_n = UDBType4 DRIVER_ID_n

Run the Batch Installer

(65)

• When the originating host is Windows, run the command:

binstaller.cmd

• When the originating host is UNIX, run the Batch Installer with the command:

sh binstaller.sh

Here is a sample run on UNIX:

$ binstaller.sh

Installation succeeded!

Please review the install.log for more information

--- Summary . . .

Number of hosts processed = 1 Number of hosts installed = 1 Number of hosts reconfigured = 0

For details look in file (install.log).

*** end Batch Install ***

• When the originating host is Windows, run the command:

binstaller.cmd

(66)

Oracle Installs

In this section

Overview...67 Configurator Windows...67 Running the Configurator Outside the Install Process...73 If you Run the Batch Installer...73

(67)

Overview

If you have chosen to install on a server with an Oracle database, additional Configurator windows prompt you for Oracle log parameters. These parameters are necessary because running in archive mode is a requirement for replication with an Oracle DBMS.

The Configurator is available with Windows, UNIX, and Linux installs. The installation may be a full install or a reconfiguration of an existing install, or as a standalone process. Installs may be local or remote, and may run in batch or interactive mode.

The topics in this section are:

• Configurator Windows

• Running the Configurator Outside the Install Process

• If you Run the Batch Installer

Configurator Windows

Note: The examples that follow may differ, depending on your platform.

A sample successful install window follows where a server has an Oracle DBMS:

1. If you click Finish, the initial Server operations screen displays.

If you chose CyberArk connections, the CyberArk Configurator Wizard displays first, as described in Configurator for CyberArk installs. When you finish configuring CyberArk connections, the Configurator displays the initial Server operations screen.

2. Specify the host name and operating system, then click Next.

Configurator for Oracle Installs

(68)

3. Click Add to configure parameters for a new database server.

If you have already added servers and highlight only one server, you may edit, delete, or add a new server. If you have already added more than one server, Edit is inactive.

Depending which button you click, you are presented with additional dialogs. After adding, editing, or deleting a server, you return to the Server operations dialog.

• Click Apply to save the pending changes.

• When you are finished, click Exit.

Adding a Server

If you are adding a server, fill out the Server information and Parameters for processing archive logs windows.

1. On the Server information window, input the database server name.

Note: You may not enter the following characters in the server name:single quote (‘), double quote (“), space ( ), tab, form feed, forward slash (/), backward slash (\), equal sign (=), and colon (:).

The DBMS Type defaults to Oracle, and the Version defaults to 10 and above.

(69)

2. Click Next.

If you enter a name that is a duplicate, you see the following message:

3. On the Parameters for processing archive logs window, input options for handling log corruption and archive logs.

4. Choose if the Change Selector continues processing when a corrupted row is detected.

If selected:

• The Change Selector starts with the Ignore log corruption option enabled.

• A status message is returned after a corrupt row is skipped.

• If you continue and ignore the corrupt row, an informational message indicating the system change number (SCN) range where the corruption occurred is displayed.

• If you do not continue, an error message is issued and the Change Selector stops. When this occurs, you must determine where to begin processing and must restart the Change Selector.

Configurator for Oracle Installs