FastExport TMSM Integration - FastExport

Teradata® FastExport Reference

Product
FastExport
Release Number
16.20
Published
September 2020
Language
English (United States)
Last Update
2020-09-11
dita:mapPath
lki1527114222329.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
B035-2410
lifecycle
previous
Product Category
Teradata Tools and Utilities

Teradata Multi-System Manager (TMSM) is the monitoring and control facility for a variety of Dual Active Solutions offered by Teradata. The expected users of this facility are administrators of the Enterprise Data Warehouse (EDW) such as Teradata Database administrators, ETL maintenance staff, systems administrators, or anyone who needs to monitor and control processes that include, but are not limited to, Teradata Load and Unload Utilities, Teradata SQL, ETL tools, and Teradata Database.

To integrate with TMSM, FastExport has been enhanced to collect operational metadata and event data, obtain the Unit of Work ID (UOW ID) from TMSM for a job, and send such data to TMSM for monitoring purposes using the “send event” interface as described in the TMSM Event System API Reference. By default, a FastExport job will send events to TMSM as long as TMSM is active. If TMSM is not active, the job will continue to run, except that no events will be sent to TMSM.

Simple ETL process monitoring requires the tracking of the “start” and “end” of the process, which can include multiple “steps”, each of which represents an activity or event of the process to be monitored. In terms of FastExport, a load job can be regarded as such a process.

FastExport follows the flow required by TMSM:

  1. Obtain a system-generated UOW ID from TMSM for a FastExport job
  2. Send a “start” event to TMSM along with the UOW ID
  3. Optionally send one or more “step” events to TMSM along with the UOW ID
  4. Send an “end” event to TMSM along with the UOW ID

Following is an example of how FastExport job containing two BEGIN EXPORT/END EXPORT tasks sends event messages to TMSM in order for the job to be monitored:

Start Event ("Connecting session(s)")
Step Event ("Task 1: "Retrieving rows begins")
Step Event ("Task 1: "Retrieving rows completes")
Step Event ("Task 2: "Retrieving rows begins")
Step Event ("Task 2: "Retrieving rows completes")
End Event  ("Job terminating")

For detailed information on setting up the TMSM environment, refer to the Teradata Multi-System Manager Installation Guide (B035-3202).