Runtime Parameters - FastExport

Table 5 lists FastExport runtime parameters for mainframe‑attached configurations.

Table 5: Runtime Parameter Descriptions (Mainframe‑Attached Systems)
Parameter	Description
BRIEF	Reduced print output runtime parameter that limits FastExport printout to the least information required to determine the success or failure of the job
CHARSET=character‑set‑name	Character set specification for the FastExport job A character set name can be specified. The character set specification remains in effect for the entire FastExport job, even if Teradata Database resets, causing the FastExport job to be restarted. Note: The character set specification does not remain in effect if the client system fails, or if the FastExport job is cancelled. In these cases, when resubmitting the job, use the same character set specification which was used on the initial job. If a different character set specification is used when a job is resubmitted, the data loaded by the restarted job does not appear the same as the data loaded by the initial job. If a character set specification is not entered, then FastExport uses the specifications in the Call‑Level Interface Version 2 (CLIv2) default files: HSHSPB for mainframe‑attached client systems. Otherwise, the default is whatever character set is specified for Teradata Database whenever FastExport is invoked. Note: When using UTF‑8 client character set on the mainframe, the client character set name needs to be specified by the runtime parameter (that is, CHARSET=UTF‑8). UTF8 is also a valid value. Note: For other ways to specify the character set, see “Character Set Specification” on page 31.
ERRLOG=filename	Alternate file specification for FastExport error messages On mainframe‑attached client systems, the alternate file specification is limited to eight characters and: On z/OS, it must be a DDNAME defined in the JCL There is no default error log filename specification.
“fastexport command”	Invocation option that can signify the start of a FastExport job It is usually a RUN FILE command that specifies the file containing the FastExport job script since only one command can be specified. Use the DD control statements to specify the input and output files before invoking the utility.
MAXSESS = max‑sessions	Maximum number of FastExport sessions logged on to Teradata Database Maximum specification must be greater than zero and no more than the total number of AMPs on the system. Default is one session for each AMP.
MINSESS = min‑sessions	Minimum number of FastExport sessions required to run the job Minimum specification must be greater than zero. Default is 1.
RVERSION	Display version number and stop
STATUS ON\|OFF	Five‑minute status reporting Use ON if enabled (the default) or OFF if disabled.

Table 6 lists FastExport runtime parameters for network‑attached configurations.

Table 6: Runtime Parameter Descriptions (Network‑Attached Systems)
Parameter	Description
< infilename	Name of the standard input file that contains the FastExport commands and Teradata SQL statements on network‑attached client systems The infilename specification redirects the standard input (stdin). If an infilename specification is not entered, the default is stdin.
> outfilename	Name of the standard output file for FastExport messages on network‑attached systems The outfilename specification redirects the standard output (stdout). If an outfilename specification is not entered, the default is stdout. Note: If an outfilename specification is used to redirect stdout, do not use the same outfilename as an output or echo destination in the ROUTE MESSAGES command. Doing so produces incomplete results because of the conflicting write operations to the same file.
‑b	Reduced print output runtime parameter that limits the FastExport printout to the least information required to determine the success or failure of the job
‑c character‑set‑name	Character set specification for the FastExport job A character set name can be specified. A character set specification remains in effect for the entire FastExport job, even if Teradata Database resets, causing the FastExport job to be restarted. Note: The character set specification does not remain in effect if the client system fails, or if the FastExport job is cancelled. In these cases, when resubmitting the job, the same character set specification must be used that was used on the initial job. If a different character set specification is used when a job is resubmitted, the data loaded by the restarted job does not appear the same as the data loaded by the initial job. If a character set specification is not entered, then FastExport uses the specifications in the CLIv2 default files: clispb.dat for network‑attached client systems. Otherwise, the default is whatever character set is specified for Teradata Database whenever you invoke FastExport. Note: When using UTF‑16 client character set on the network, the client character set name needs to be specified by the runtime parameter (that is, ‑c UTF‑16). UTF16 is also a valid value. Note: For other ways to specify the character set, see “Character Set Specification” on page 31.
‑e filename	Alternate file specification for FastExport error messages Specifying an alternate file name produces a duplicate record of all FastExport error messages; the entire output stream does not have to be viewed to determine why a job failed. There is no default error log filename specification.
‑i scriptencoding	Encoding form of the job script The parameter is introduced for use with the UTF‑16 client character set, so it is only valid when UTF‑16 client character set is used. If the client character set being used is not UTF‑16 and the parameter is specified, FastExport reports an error and terminates. Valid encoding options are: UTF‑8 or UTF8 UTF‑16BE, or UTF16‑BE, or UTF16BE UTF‑16LE, or UTF16‑LE, or UTF16LE UTF‑16 or UTF16 UTF‑8 indicates the job script is in UTF‑8character set UTF‑16 indicates the job script is in UTF‑16 character set without specifying the endianness UTF‑16BE indicates the job script is in big endian UTF‑16 character set UTF‑16LE indicates the job script is in little endian UTF‑16 character set. Or, if UTF‑16LE is specified but the UTF‑16 Byte Order Mark (BOM) in the script file indicates the script is in big endian, FastExport reports an error and terminates. The UTF‑16 or UTF‑8 BOM can be present or absent in the script file. Specify the input script format with ‑i runtime parameter (mandatory) and specify session character set with ‑c runtime parameter (mandatory) to ensure that the BOM in the script file is processed correctly. When UTF‑16 is specified and the UTF‑16 BOM is present in the script file, FastExport will interpret the script according to the endianness indicated by the UTF‑16 BOM. When the UTF‑16 BOM is not present, FastExport will interpret the script according to the endianness indicated by the option value. If the endianness is not indicated by the option value (that is, UTF‑16 is specified instead of UTF‑16BE or UTF16‑LE), FastExport will interpret the job script in UTF‑16 according to the endianness of the client system where the FastExport job invoked. The specified encoding character set applies to all script files included by the .RUN FILE commands. When this runtime parameter is not specified and UTF‑16 client character is used, FastExport will interpret the job script in UTF‑16. When UTF‑8 is specified, FastExport will interpret the job script in UTF‑8 and will convert SQL and Data Manipulation Language (DML) statements in the script from UTF‑8 to UTF‑16 before sending the SQL and DML statements to Teradata Database.
‑M max‑sessions	Maximum number of FastExport sessions logged on to Teradata Database Maximum specification must be greater than zero and no more than the total number of AMPs on the system. Default is one session for each AMP.
‑N min‑sessions	Minimum number of FastExport sessions required to run the job. Minimum specification must be greater than zero. Default is 1.
‑r 'fastexport command'	Invocation option that can signify the start of a FastExport job It is usually a RUN FILE command that specifies the file containing the FastExport job script since only one command can be specified.
‑s value	Five‑minute status reporting For value, use ON if reporting is enabled, or OFF if disabled.
‑u outputencoding	Specifies the encoding form of the job output The parameter is introduced for being used for UTF‑16 client character set so it is only valid when UTF‑16 client character set is used. If the client character set being used is not UTF‑16 and the parameter is specified, FastExport reports an error and terminates. Valid encoding options are: UTF‑8 or UTF8 UTF‑16BE, or UTF16‑BE, or UTF16BE UTF‑16LE, or UTF16‑LE, or UTF16LE UTF‑16 or UTF16 UTF‑16BE instructs FastExport to print the job output in the big endian UTF‑16 character set UTF‑16LE instructs FastExport to print the job output in the little endian UTF‑16 character set On big endian client systems, UTF‑16 instructs FastExport to print the job output in big endian UTF‑16 character set On the little endian client systems, UTF‑16 instructs FastExport to print the job out in little endian UTF‑16 character set UTF‑16 BOM is printed as a part of job output for: UTF‑16BE, or UTF16‑BE, or UTF16BE UTF‑16LE, or UTF16‑LE, or UTF16LE UTF‑16 or UTF16 encoding When the parameter is not specified and the client character set being used is UTF‑16, the job output will be printed as UTF‑16.
‑y	Specification for the data encryption option When specified at run time, all sessions will be encrypted.
‑V	Display version number and stop

Note: For sample JCL and commands that invoke FastExport on the different operating system platforms, see Appendix B: “Invocation Examples.”

The first occurrence of the runtime parameter is in effect if the duplicates are specified. The remaining parameters will be omitted with a warning message “UTY2430 Warning: Run time parameters detected and omitted”.