ROUTE MESSAGES - FastExport

Teradata FastExport Reference

Product
FastExport
Release Number
15.10
Language
English (United States)
Last Update
2018-10-07
dita:id
B035-2410
lifecycle
previous
Product Category
Teradata Tools and Utilities

The ROUTE MESSAGES command identifies an alternate destination for the report output produced by the FastExport utility. One or more ROUTE MESSAGES command may be included anywhere in the command stream.

where:

 

Syntax Element

Description

ECHO

Additional destination, with a fileid specification

For example, use the ECHO keyword to specify that messages be captured in a file (fileid2) while still being written to the terminal.

Note: The ECHO OFF specification cancels the additional file specification of a previously established ECHO destination.

fileid1 and fileid2

Alternate message destinations in the external system:

  • In z/OS, the fileid is a DDNAME.
  • In UNIX OS and Windows, the fileid is the path name for a file
  • If the path name has embedded white space characters, must enclose the entire path name in single or double quotes.

    If the path name is enclosed by single quotation marks and there is an embedded single quotation mark, then an escape character (single quotation mark) needs to precede the embedded single quotation mark. Likewise, if the path name is enclosed by double quotation marks and there is an embedded double quotation mark, then an escape character (double quotation mark) needs to precede the embedded double quotation mark.

    If the path name contains single or double quotation marks, it should be enclosed in either single or double quotation marks.

    If the same destination with both fileid1 and fileid2 parameters is specified, FastExport duplicates the messages at each destination.

    Table 42 describes the things to consider when using the ROUTE MESSAGES command.

     

    Table 42: ROUTE MESSAGES Command Usage Notes 

    Topic

    Usage Notes

    Specifying the System Console/Standard Output Device

    Use the asterisk (*) character as the fileid1 or fileid2 specifications to route messages to the system console/standard output (stdout) device.

    The system console is the:

  • Display screen in interactive mode
  • Standard output device in batch mode
  • For more information about the display screen and standard output devices, see “File Requirements” on page 13.

    Default Message Destinations

    If the ROUTE MESSAGES command is not used, FastExport writes output messages to:

  • DDNAME SYSPRINT in z/OS
  • stdout in UNIX OS and Windows
  • z/OS fileid Usage Rules

    If a DDNAME is specified, FastExport writes messages to the specified source.

    A DDNAME must obey the same construction rules as Teradata SQL column names except that:

  • The “at” character (@) is allowed as an alphabetic character
  • The underscore character (_) is not allowed
  • The DDNAME must obey the applicable rules of the external system and may reference a sequential or VSAM data set.

    If the DDNAME represents a data source on magnetic tape, the tape may be either labeled or nonlabeled, as supported by the operating system.

    In the following example, the messages are written to the file designated by OUTPUT from this point unless redirected by another ROUTE MESSAGES command:

    .ROUTE MESSAGES FILE OUTPUT;

    Note: On UNIX and Windows platforms, if the same outfilename is used to redirect stdout and as the fileid in a ROUTE MESSAGES WITH ECHO command, the results written to outfilename may be incomplete due to conflicting writes to the same file.