Run-time Parameters

Teradata MultiLoad Reference

brand
Teradata Tools and Utilities
prodname
MultiLoad
vrm_release
16.10
category
Programming Reference
featnum
B035-2409-057K

This section describes the run-time parameters used by Teradata MultiLoad.

Run-time Parameters for Mainframe-Attached Configurations

The following table lists Teradata MultiLoad run-time parameters for mainframe-attached configurations.

Run-time Parameters (Mainframe-Attached Configurations) 
Parameter Description
BRIEF Reduced print output run-time parameter that limits Teradata MultiLoad printout to the minimal information required to determine the success of the job:
  • Logon/logoff information
  • Candidate records
  • Insert, update, and delete results
  • Error table counts
CHARSET= character-set-name Character set specification for the Teradata MultiLoad job

Specify any character set installed on the Teradata server, by its character set name. For a listing of character set names, see Character Set Specification.

The character set specification remains in effect for the entire Teradata MultiLoad job, even if Teradata Database resets, causing the Teradata MultiLoad job to be restarted. However, the character set specification does not remain in effect if the client system fails, or if the Teradata MultiLoad job is cancelled. In these cases, when resubmitting the job, use the same character set specified on the initial job. If a different character set specification is used when the job is resubmitted, the data loaded by the restarted job will not appear the same as the data loaded by the initial job.

If a character set specification is not entered, the default is the character set specified for Teradata Database when Teradata MultiLoad is invoked.

For more information about specifying and using character sets, see Character Set Specification.
ERRLOG= filename Alternate file specification for Teradata MultiLoad error messages

Specifying an alternate file name produces a duplicate record of all Teradata MultiLoad error messages.

On mainframe-attached client systems, the alternate file specification is limited to eight characters and:

  • On z/OS, it must be a DD name defined in the JCL

There is no default error log file name specification.

MAXSESS = max-sessions Maximum number of Teradata MultiLoad 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 Teradata MultiLoad sessions required to run the job

Minimum specification must be greater than zero.

Default is one.

“Teradata MultiLoad command Invocation option that can signify the start of a Teradata MultiLoad job on a network-attached system

Since only one Teradata MultiLoad command can be specified as the Teradata MultiLoad command specification, it is usually a RUN FILE command that specifies the file containing the Teradata MultiLoad job script.

Use the DD control statements to specify the input and output files before invoking the utility.

RVERSION Display version number and stop.

Run-time Parameters for Network-Attached Configurations

The following table lists Teradata MultiLoad run-time parameters for network-attached configurations.

Run-time Parameters (Network-Attached Configurations) 
Parameter Description
-b Reduced print output run-time parameter that limits Teradata MultiLoad printout to the minimal information required to determine the success of the job:
  • Logon/logoff information
  • Candidate records
  • Insert, update, and delete results
  • Error table counts
-c character-set-name Character set specification for the Teradata MultiLoad job

Specify any character set installed on the Teradata server, by its character set name. For a listing of character set names, see Character Set Specification.

The character set specification remains in effect for the entire Teradata MultiLoad job, even if Teradata Database resets, causing the Teradata MultiLoad job to be restarted. However, the character set specification does not remain in effect if the client system fails, or if the Teradata MultiLoad job is cancelled. In these cases, when resubmitting the job, use the same character set specified on the initial job. If a different character set is specified when a job is resubmitted, the data loaded by the restarted job will not appear the same as the data loaded by the initial job.

If a character set specification is not entered, the default is the character set specified for Teradata Database when Teradata MultiLoad is invoked.

For more information about how to specify and work with character sets, see Character Set Specification.
-efilename Alternate file specification for Teradata MultiLoad error messages

Specifying an alternate file name produces a duplicate record of all Teradata MultiLoad error messages.

There is no default error log file name specification.

-i scriptencoding Encoding form of the job script

If this parameter is not specified and the client character set is UTF-16, Teradata MultiLoad interprets the job script to UTF-16. If character-type data is also specified in the script, Teradata MultiLoad converts the string literals and the corresponding field in the import data to the same character set before comparing or concatenating them. (String literals are specified with .APPLY…WHERE….; LAYOUT…CONTINUEIF….; FIELD…NULLIF….; FIELD…||…commands.)

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

The specified encoding character set applies to all script files included by the .RUN FILE commands.

The UTF-16 or UTF-8 Byte Order Mark (BOM) can be present or absent in the script file.

When UTF-16 BOM is present and 'UTF-16' is specified, Teradata MultiLoad interprets the script according to the endianness indicated by the UTF-16 BOM. When the UTF-16 BOM is not present, Teradata MultiLoad interprets the script according to the endianness indicated by the encoding option.

UTF-8 BOM is not supported on the z/OS platform when using access modules or data files.
< infilename Name of the standard input file that contains Teradata MultiLoad commands and Teradata SQL statements on network-attached client systems

The infilename specification redirects the standard input (stdout). If an infilename specification is not entered, the default is stdin.

-M max-sessions Maximum number of Teradata MultiLoad 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 Teradata MultiLoad sessions required to run the job

Minimum specification must be greater than zero.

Default is one.

> outfilename Name of the standard output file for Teradata MultiLoad messages on network-attached systems

The outfilename specification redirects the standard output (stdout). If an out file name specification is not entered, the default is stdout.

If an outfilename specification to redirect stdout is used, do not use the same outfilename as an output or echo destination in the DISPLAY command or ROUTE MESSAGES command. Doing so produces incomplete results because of the conflicting write operations to the same file.
-r 'Teradata MultiLoad command'' Invocation option that can signify the start of a Teradata MultiLoad job on a network-attached system

Since only specify one Teradata MultiLoad command as the Teradata MultiLoad command specification, it is usually a RUN FILE command that specifies the file containing the Teradata MultiLoad job script.

-u outputencoding Encoding form of the job output

The parameter is valid only when the UTF-16 client character set is used. If the client character set being used is not UTF-16 and this parameter is specified, Teradata MultiLoad reports an error and terminates.

Available output encoding options are:

  • UTF-16BE, or UTF16-BE, or UTF16BE
  • UTF-16LE, or UTF16-LE, or UTF16LE
  • UTF-16 or UTF16

UTF-16BE, or UTF16-BE, or UTF16BE instructs Teradata MultiLoad to print the job output in big endian UTF-16 encoding scheme.

UTF-16LE instructs Teradata MultiLoad to print the job output in little endian UTF-16 encoding scheme. On big endian client systems, UTF-16 instructs Teradata MultiLoad to print the job output in big endian UTF-16 encoding scheme. On little endian client systems, UTF-16 instructs Teradata MultiLoad to print the job output in little endian UTF-16 encoding scheme.

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 encodings
-V Display version number and stop.
-y Specification for the data encryption option

When specified at run time, all sessions will be encrypted.

For sample JCL listings, commands, and output samples for the invocation options, see Invocation Examples.
The first occurrence of the run-time 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”.