Create the <host_name>.properties file - Connect_CDC - connect_cdc_mimix_share - 5.8

Connect CDC Installation Guide

Product type
Software
Portfolio
Integrate
Product family
Connect
Product
Connect > Connect CDC (MIMIX Share)
Version
5.8
Language
English
Product name
Connect CDC
Title
Connect CDC Installation Guide
Copyright
2023
First publish date
2003
ft:lastEdition
2023-09-11
ft:lastPublication
2023-09-11T16:55:56.594134
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.

Keyword

Description

HOST_NAME

Network name or IP address of the host to be installed on.

HOST_USER

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_PASS

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.

JAVA_PATH

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.

INSTALL_CD

Directory location of the omni.zip install file.

The Installer requires the current working directory to be writable.

INSTALL_DIRECTORY

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

LISTENER_PORT

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.

INITIAL_MEMORY

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.

MAXIMUM_MEMORY

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.

SSL_ENCR

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.

INSTALL_CLIENT

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

NUM_DRIVERS

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.

DRIVER_ID_n

Where n is a number from 1 to NUM_DRIVERS.

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

  • Db2ZOS

  • Informix

  • Informix14 (looks for driver jdbc-4.50.9.jar)
  • JTOpen400

  • Kafka

  • MySQL

  • Oracle11g

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

  • PostgreSQL

  • Snowflake
  • SQLServer

  • Sybase3 (looks for driver jconn4.jar)

  • Teradata14

  • Teradata15

  • Teradata16

  • Teradata17

  • UDBType4

DRIVER_CLASSPATH_n

Where n is a number from 1 to NUM_DRIVERS.

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.

ROOT_PASS

(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.

INSTALL_JETTY

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.

SSHD_PORT

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.

TRANSLATE_BINARY

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.

TARGET_ONLY

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

CRED_REPO_SERVICE_URL

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.

Required to use CyberArk passwords for server connection credentials.

Note: The installer does not support CyberArk configurations in a remote install.

CRED_REPO_KEY_STORE_PASS

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_CERT_ALIAS

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

CRED_REPO_KEY_CERT_FILE

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_TRUST_STORE_PASS

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_FILE

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.

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

Keyword

Description

ROOT_PASS

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 Start Connect CDC Listener for more information.)

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