Before you can use Teradata Connector, ensure that you meet the prerequisite tasks.
Perform the following prerequisite tasks:
1Install the Teradata Parallel Transporter utilities and set the environment variables.
2Ensure that you have access to the Secure Agent directory that contains the success and error files. This directory path must be the same on each Secure Agent machine in the runtime environment. The Teradata JDBC driver is packaged with the Secure Agent. When you install the Secure Agent, the JDBC driver is installed and the JDBC jars are copied to the Secure Agent machine.
3Configure the authentication prerequisites to connect to a Teradata database. You can configure Native, LDAP, or KRB5 authentication. Keep the authentication details handy based on the authentication type that you want to use.
Teradata Parallel Transporter Utilities
Before you use Teradata Connector, install the Teradata Parallel Transporter utilities on the Secure Agent machine.
You must install the following Teradata Parallel Transporter utilities:
•Teradata Parallel Transporter Base
•Teradata Parallel Transporter Stream Operator
•Teradata CLIv2
•Teradata Generic Security Services
•Shared ICU Libraries for Teradata
Prepare for Kerberos authentication
You can use Kerberos authentication to connect to Teradata databases by placing the required configuration files on the Secure Agent machine.
When you configure Kerberos authentication to connect to Teradata, consider the following guidelines:
•You can't use the Hosted Agent or serverless runtime environment.
•Ensure that the Secure Agent and database server that you use are registered in the KDC server.
•You can't add more than one KDC to a krb5.conf file.
•Consider the following guidelines to generate a credential cache file:
- On Linux, you can generate a credential cache file for more than one Kerberos principal user in a connection. However, you can use only one Kerberos principal user within a mapping.
- On Windows, you can't generate a credential cache file for more than one Kerberos principal user in a connection.
Configuring the Kerberos authentication
Before you use Kerberos authentication to connect to Teradata on Linux or Windows, the organization administrator needs to perform the prerequisite tasks.
1To configure the Java Authentication and Authorization Service configuration file (JAAS), perform the following tasks:
aCreate a JAAS configuration file on the Secure Agent machine.
bAdd the following entries to the JAAS configuration file:
[realms] <REALM NAME> = { kdc = <Location where KDC is installed> admin_server = <Location where KDC is installed> } [domain_realm] <domain name or host name> = <Domain name or host name of Kerberos> <domain name or host name> = <Domain name or host name of Kerberos>
3To set the environment variables on the Secure Agent machine, complete the following steps:
- setenv KRB5CCNAME <Absolute path and file name of the credentials cache file>
- setenv KRB5_CONFIG <Absolute path of the Kerberos configuration file>\krb5.conf
- setenv JAASCONFIG <Absolute path of the JAAS config file>\<File name>.conf
4Restart the Secure Agent.
5To generate the credential cache file on the Secure Agent machine and use Kerberos authentication to connect to Teradata, perform the following steps:
aOn the Secure Agent machine, run the following command and specify the Teradata user name and realm name:
Kinit <user name>@<realm_name>
bOptionally, when you connect to Teradata databases on Linux, you can run the following command to generate the credential cache file with the specified file name and directory on the Secure Agent machine:
Kinit -c <Directory and file name where you want to create the credential cache> <user name>@<realm_name>
cWhen prompted, enter the password for the Kerberos principal user.
6Add the KRB5_CONFIG, KRB5CCNAME, and JAASCONFIG properties in the Kerberos Artifacts Directory field in the Teradata connection.
For example, add the properties in the following format:
KRB5_CONFIG=<Absolute path of the Kerberos configuration file>\krb5.conf,KRB5CCNAME=<Absolute path of the credential cache file>/<File name>,JAASCONFIG=<Absolute path of the JAAS config file>\<File name>.conf
Note: Ensure that you separate each key-value pair with a comma.
Setting environment variables
You must configure Java and Teradata environment variables before you can use Teradata Connector.
The following table describes the environment variables you must set on UNIX:
Environment Variable
Value
THREADONOFF
On UNIX and Linux, set the THREADONOFF environment variable to 1 to enable multithreading support for Teradata processes.
NLSPATH
Set the NLSPATH variable to the location of the opermsgs.cat file.
For example, /opt/teradata/client/15.10/msg/%N
Also, set the shared library environment variable based on the operating system.
The following table describes the shared library variables for each operating system: