2.05 - Target Object - Teradata Listener

Teradata® Listener™ User Guide

Teradata Listener
March 2019
User Guide

Properties used to define a target object are as follows:

Property Type Example Description
target_id string 758fbda4-accc-4f90-8f09-cc0a164c8c28 Target ID. Read-Only.
source_id string 84757abc-ba43-5736-0ba3-1bdac4748290 Source ID associated with this target.
system_id string 9dda5570-70e0-45be-8449-83f33320cd08 System ID associated with this target.
owner array ["jd123456"] Array of user IDs with owner permissions on the source. Automatically assigned.
created_at string 2015-07-04T10:20:00Z Timestamp of moment the target was created. Read-Only.
created_by string av012345 User ID who created the target. Read-Only.
updated_at string 2015-12-25T10:20:00Z Timestamp of moment of update. Read-Only.
updated_by string jd123456 User ID who last updated the target. Read-Only.
name string My Data Target Target name.
description string A superb data target Target description.
target_type string teradata Target type. Must match the associated system type.
data_path object {"schema": "listener": "table": "demo"}

"foreign_server": "Listener"

Specific data path on target system. Details vary by target type. If using Teradata QueryGrid, the additional property for foreign_server is required.
system_info object {"password": "ip112233", "username": "8080" "target_subtype": "querygrid"} Specific target system connection information. Details vary by target type. If using Teradata QueryGrid, the additional property for target_subtype is required.
state string 1 Target state: enabled or disabled. Is automatically assigned. To change, delete an item.
production boolean false Production state of the target. When enabled, prevents modifications. Read-Only.
bundle boolean true Flag to indicate the target is batched (true) or real-time (false).
bundle_type records records When in batch mode, declare mode using records.
bundle_interval integer 200 When batch mode, declare the number of records during a batch.
data_map object { "mapping":[{"field": "uuid", "column": "uuid", "type": "varchar"}] }


Describes how to map target fields to system columns.

Optional field “mapping_type” can be used to specify “shredding” or “auto_shred”. For example:


properties object {"webhcat_table": "listener"} Additional properties for some target types.
use_dead_letter_queue boolean true Determines whether to move bad records to a separate queue (true) or not (false).
dead_letter_queue string b37979f6-b712-4d81-990e-9556a3c0e94b-dlq Automatically populated with the name of the queue used to store failed records when the use_dead_letter_queue value is true. Read-only.