Create a Teradata connection to securely read data from or write data to Teradata.
Prerequisites
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
Configuring the Kerberos authentication
You can configure Kerberos for a Secure Agent only on a Linux machine. Configure the Secure Agent to use Kerberos to authenticate when you connect to a Teradata database.
Before your configure Kerberos authentication, ensure that you have the required Kerberos configuration files, such as krb5.conf and IICSTPT.keytab. The Secure Agent uses the IICSTPT.keytab file to generate Kerberos TGT cache entries at runtime.
Create the Kerberos configuration files
The Secure Agent requires the keytab files to authenticate users to connect to Teradata.
To generate the keytab file, perform the following steps:
1Edit the krb5.conf and set default_tgs_enctypes = arcfour-hmac-md5.
2Add the encryption configuration property in the krb5.conf file in the [libdefaults] section.
For example, set the following entries for the klist ouput in the keytab file:
The Secure Agent uses the keytab file information that you specify and creates the Kerberos TGT cache in the $PMTempDir directory at runtime. The Kerberos TGT cache is active during the length of the session and ends when the session completes.
Add the Kerberos configuration files to the Kerberos artifacts directory
Add the krb5.conf and IICSTPT.keytab files to a directory on the Secure Agent machine.
When you select KRB5 as the authentication type in the Teradata connection, specify the directory that contains these files in the Kerberos Artifacts Directory field.
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:
After you set the environment variables, restart the Secure Agent.
Connect to Teradata
Let's configure the Teradata connection properties to connect to Teradata.
Before you begin
Before you get started, be sure to complete the prerequisites.
Check out Prerequisites to learn more about the authentication prerequisites and tasks that you must perform.
Connection details
The following table describes the basic connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
Teradata
Runtime Environment
The name of the runtime environment where you want to run tasks.
Specify a Secure Agent.
TDPID
The name or IP address of the Teradata database machine.
Database Name
The Teradata database name.
If you do not enter a database name, Teradata PT API uses the default login database name.
Code Page
Code page associated with the Teradata database.
Select one of the following code pages:
- MS Windows Latin 1. Select for ISO 8859-1 Western European data.
- UTF-8. Select for Unicode and non-Unicode data.
When you run a task that extracts data from a Teradata source, the code page of the Teradata PT API connection must be the same as the code page of the Teradata source.
Authentication types
You can configure the Native, LDAP, or KRB5 authentication type to connect to the Teradata database.
Select the required authentication type and then configure the authentication-specific parameters.
Note: Data Ingestion and Replication does not support the KRB5 and LDAP authentication types.
Native authentication
To configure native authentication, you need the user name and password from your Teradata account.
The following table describes the basic connection properties for Native authentication:
Property
Description
Username
User name with the appropriate read and write database permissions to access the Teradata database.
Password
Password for the database user name.
LDAP authentication
To configure LDAP authentication, you need to authenticate user credentials against the external LDAP directory service.
Note: Data Ingestion and Replication does not support the LDAP authentication type.
The following table describes the basic connection properties for LDAP authentication:
Property
Description
Username
User name with the appropriate read and write database permissions to access the LDAP database.
Password
Password for the LDAP database user name.
KRB5 authentication
To configure KRB5 authentication, you must configure the Secure Agent hosted on the Linux machine and ensure that the Kerberos artifacts directory contains the Kerberos configuration files.
Note: Data Ingestion and Replication does not support the KRB5 authentication type.
The following table describes the basic connection properties for KRB5 authentication:
Property
Description
Username
The Kerberos user name that authenticates to the Teradata database.
The following table describes the advanced connection properties for KRB5 authentication:
Property
Description
Kerberos Artifacts Directory
Directory that contains the Kerberos configuration files.
This directory contains the following configuration files:
- krb5.conf
- IICSTPT.keytab
Advanced settings
The following table describes the advanced connection properties:
Property
Description
Tenacity
Amount of time, in hours, that the Teradata PT API continues attempting to log in again when the maximum number of operations runs on the Teradata database.
Specify a positive integer.
Default is 4.
Max Sessions
Maximum number of sessions allowed for the Teradata PT API to establish connection with the Teradata database.
Specify a positive, non-zero integer. Default is 4.
Min Sessions
Minimum number of Teradata PT API sessions required for the Teradata PT API job to continue.
Specify a positive integer between 1 and the value specified in the Max Sessions field.
Default is 1.
Sleep
Amount of time, in minutes, that the Teradata PT API waits before it attempts to log in again when the maximum number of operations run on the Teradata database.
Specify a positive, non-zero integer.
Default is 6.
Data Encryption
Enables full security encryption of SQL requests, responses, and data.
Default is disabled.
Block Size
Maximum block size, in bytes.
Teradata PT API uses this property to read the data block size from source through the Export operator.
Maximum is 16775168 bytes for Teradata database version 16.20 and later.
If the Teradata database version is earlier than 16.20, Teradata scales down the block size from 16775168 bytes to the maximum allowed value. The block size 16775168 is not allowed in the Spool mode.
For more information, see the Teradata logs and verify the Teradata documentation of the same version.
Metadata Advanced Connection Properties
The optional properties for the JDBC driver to fetch the metadata from Teradata.
For example, tmode=ANSI.
Enable Metadata Quotification
Determines if a Teradata connection reads reserved words used in table or column names from the Teradata database.
Select the Enable Metadata Quotification checkbox for the Secure Agent to read reserved words from Teradata.
Database privileges
Before you use Teradata Connector, select privileges on specific Data Dictionary tables.
Verify that you have the following database privileges:
•Select privileges on DBC.Tables, DBC.Columns, DBC.UDTInfo, and DBC.Databases.
For information about select privileges, see the Teradata JDBC Driver documentation.