tTeradataTPTUtility – Docs for ESB 5.x

Component Family

Databases/Teradata

Function

As the combination of tTeradataFastLoad, tTeradataMultiLoad, tTeradataTPump, and tTeradataFastExport, tTeradataTPTUtility writes the incoming data to a
file and then loads the data from the file to a Teradata database.

Purpose

tTeradataTPTUtility writes the
incoming data to a file and then loads the data from the file to a
Teradata database.

Basic settings

Data file

Property Type

Either Built-In or Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

Built-In: No property data stored
centrally.

Repository: Select the repository
file in which the properties are stored. The Filename field is completed automatically using the
data retrieved.

Filename

Append

Select this check box to append the incoming data in the file
specified in the Filename
field.

Connection

Property Type

Either Built-In or Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

Built-In: No property data stored
centrally.

Repository: Select the repository
file in which the properties are stored. The database connection
related fields that follow are completed automatically using the
data retrieved.

Execution platform

Select the Operating System that will be used to run the Job, either Windows or Unix.

TDPID

Specify the Teradata director program identifier. It can be either
the name or the IP address of the Teradata database system being
accessed.

Database name

Specify the name of the Teradata database.

Username and
Password

Specify the username and the password for the Teradata database
authentication.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.

Schema and Edit
Schema

A schema is a row description. It defines the number of fields to be processed and passed on
to the next component. The schema is either Built-In or
stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

Built-In: You create and store the schema locally for this
component only. Related topic: see Talend Studio
User Guide.

Repository: You have already created the schema and
stored it in the Repository. You can reuse it in various projects and Job designs. Related
topic: see Talend Studio User Guide.

Click Edit schema to make changes to the schema. If the
current schema is of the Repository type, three options are
available:

Consumer Operator

Select a consumer operator from the drop-down list.

For more information about Teradata consumer operators, see http://www.info.teradata.com/HTMLPubs/DB_TTU_14_00/index.html#page/Load_and_Unload_Utilities/B035_2445_071A/2445ch02.109.18.html.

Action On Data

Select an action to be performed on the data from the drop-down list.

This list field appears only when the Update or Stream
operator is selected from the Consumer
Operator drop-down list.

Producer Operator

Select a producer operator from the drop-down list. Currently,
only the DataConnector operator is
supported.

DataConnector: accesses files
either directly or through an access module, and then writes it to
the data stream.

For more information about Teradata producer operators, see http://www.info.teradata.com/HTMLPubs/DB_TTU_13_10/index.html#page/Load_and_Unload_Utilities/B035_2445_020A/2445ch02.04.16.html.

Table

Specify the name of the table to be written into the Teradata
database. Note that only one table can be written at a time.

Script generated folder

Specify the directory under which the Teradata Parallel
Transporter script file will be created during the Job execution.
This script file will be deleted at the end of the Job
execution.

Error file

Specify the file in which log messages will be recorded.

 Advanced settings

Row separator

Character, string or regular expression to separate rows.

Field separator

Character, string or regular expression to separate fields.

Include header

Select this check box to include the column header to the
file.

Encoding

Select the encoding from the list or select Custom and define it manually. This field is
compulsory for database data handling.

Set Script Parameters

Select this check box to define script parameters, which will be
used when generating a script during the Job execution. If you do
not specify them manually, the system will use their default
values.

Load Operator

Specify the load operator.

This field appears only when the Set Script
Parameters check box is selected.

Data Connector

Specify the data connector.

This field appears only when the Set Script
Parameters check box is selected.

Job Name

Specify the name of a Teradata Parallel Transporter Job which is
defined using the Teradata tbuild
command.

For further information about the tbuild
command, see http://developer.teradata.com/sites/all/files/documentation/linked_docs/html/online/B035-2436-088A/wwhelp/wwhimpl/js/html/wwhelp.htm.

This field appears only when the Set Script
Parameters check box is selected.

Layout Name (schema)

Specify a schema for the data to be loaded.

This field appears only when the Set Script
Parameters check box is selected.

Define Log table

Select this check box to specify a log table so that log messages
recorded in the log file will also be written into the log
table.

Return mload error

Select this check box to specify the exit code number to indicate
the point at which an error message should display in the
console.

Define character set

Select this check box to specify the character encoding to be used
in your system.

Apply TPT consumer operator optional attributes

Select this check box to define optional attribute(s) for the
consumer operator that you have selected.

For more information about optional attributes of each consumer
operator, see Teradata Parallel Transporter
Reference guide at http://developer.teradata.com/sites/all/files/documentation/linked_docs/2436020A_TPT-Reference-13.10.pdf.

Optional attributes

Click the [+] button below the
table to add as many rows as needed, each row for an optional
attribute, and set the following two parameters for each
attribute:

For more information about the attribute value definition, see
Teradata Parallel Transporter
Reference guide at http://developer.teradata.com/sites/all/files/documentation/linked_docs/2436020A_TPT-Reference-13.10.pdf.

This table appears only when the Apply TPT
consumer operator optional attributes check box is
selected.

tStatCatcher Statistics

Select this check box to collect the log data at the component
level.

Global Variables

EXIT_VALUE: the process exit code. This is an After
variable and it returns an integer.

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio
User Guide.

Usage

Preceded by an input component, tTeradataTPTUtility writes the incoming data to a
file and then loads the data from the file to the Teradata Database.
High performance is provided during this process. For further
information about the usage of this component, see http://developer.teradata.com/sites/all/files/documentation/linked_docs/html/online/B035-2436-088A/wwhelp/wwhimpl/js/html/wwhelp.htm.

Limitation

The Teradata client tool with the Teradata Parallel Transporter
Base and Teradata Parallel Transporter Stream features needs to be
installed on the machine where Jobs using this component are
executed.