15.00 - Teradata MultiLoad Configuration File - MultiLoad

Teradata MultiLoad Reference

prodname
MultiLoad
vrm_release
15.00
category
Programming Reference
featnum
B035-2409-034K

Teradata MultiLoad Configuration File

Use a Teradata MultiLoad configuration file to set the initial default values for the following operating parameters when invoking Teradata MultiLoad:

  • AMPCHECK
  • BRIEF
  • OFORMAT
  • IFORMAT
  • CHARSET
  • ERRLOG
  • MATCHLEN
  • MAXSESS
  • MINSESS
  • DATAENCRYPTION=ON or OFF
  • CONFIGERRORS
  • RETRYFIRSTCONNECT
  • RETRYOTHERCONNECT
  • RETRYCONNECTINTERVAL
  • Note: RETRYFIRSTCONNECT, RETRYOTHERCONNECT and RETRYCONNECTINTERVAL can only be specified in the configuration file for network-attached platforms. There are no corresponding command line options.

    The values specified in the Teradata MultiLoad configuration file override the internal utility default values for these parameters.

    The configuration file parameters can themselves be overridden by the corresponding run‑time parameters, shown earlier in this chapter. (There is no MATCHLEN run‑time parameter.) The order of preference for these parameters, from highest to lowest, is:

    1—Run‑time parameters
    2—Teradata MultiLoad script
    3—Teradata MultiLoad configuration file specifications
    4—Teradata MultiLoad default values

    Configuration File Name and Location

    On network-attached systems, the Teradata MultiLoad configuration file must be named mloadcfg.dat and it must be located in either:

  • The directory from which Teradata MultiLoad was launched
  • or

  • The directory specified in the MLOADLIB environment variable
  • On mainframe-attached systems, the DD statement for the Teradata MultiLoad configuration file must be labeled MLOADCFG.

    Configuration File Contents

    The Teradata MultiLoad configuration file can have up to eleven entries, one for each parameter:

    AMPCHECK=none/all/apply
    BRIEF=on/off
    OFORMAT=outputencoding
    IFORMAT=scriptencoding
    CHARSET=character-set-name
    ERRLOG=filename
    MATCHLEN=on/off
    MAXSESS=max-sessions
    MINSESS=min-sessions
    DATAENCRYPTION=ON/OFF
    CONFIGERRORS=IGNORE/TERMINATE
    RETRYFIRSTCONNECT=n
    RETRYOTHERCONNECT=n
    RETRYCONNECTINTERVAL=s

    where

  • none/all/apply for AMPCHECK configures the Teradata MultiLoad response to a down AMP condition, see “Dealing with AMPS” on page 65 and “BEGIN MLOAD and BEGIN DELETE MLOAD” on page 106 for more detailed information
  • on/off for BRIEF configures the reduced print output specification for the Teradata MultiLoad job
  • outputencoding for OFORMAT is the character set specification for the screen output. This parameter can be used on network-attached systems only.
  • Valid values for UTF-16 are UTF16 and UTF-16
  • Valid values for UTF-16BE are UTF-16BE, UTF16-BE and UTF16BE
  • Valid values for UTF-16LE are UTF-16LE, UTF16-LE, and UTF16LE
  • scriptencoding for IFORMAT is the character set specification for the job script file. This parameter can be used on network-attached systems only.
  • Valid values for UTF-16 are UTF16 and UTF-16
  • Valid values for UTF-16BE are UTF-16BE, UTF16-BE and UTF16BE
  • Valid values for UTF-16LE are UTF-16LE, UTF16-LE, and UTF16LE
  • 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.
  • character-set-name is the character set specification for the Teradata MultiLoad job.
  • filename is the alternate file specification for Teradata MultiLoad error messages.
  • on/off for MATCHLEN configures the record length validation option for the Teradata MultiLoad job. When MATCHLEN is enabled, Teradata MultiLoad verifies that the record length of the import data is the same as the layout record length specified by the IMPORT command.
  • max-sessions is the MAXSESS specification for the maximum number of Teradata MultiLoad sessions logged on to Teradata Database.
  • min-sessions is the MINSESS specification for the minimum number of Teradata MultiLoad sessions required to run the job.
  • ON/OFF for DATAENCRYPTION specifies whether data encryption will be enabled for the Teradata MultiLoad job.
  • IGNORE/TERMINATE configures the option for the Teradata MultiLoad configuration file error handling.
  • n specified for RETRYFIRSTCONNECT is the maximum number of connection retries when MultiLoad attempts to connect to the database the first time to SQL main session and it receives the CLI 207 error returned. The default value is 0.
  • n specified for RETRYOTHERCONNECT is the maximum number of connection retries when MultiLoad attempts to connect to the database the other connections and it receives the CLI 207 error returned. The default value is 16.
  • s specified for RETRYCONNECTINTERVAL is the interval in seconds between retries. The default value is 60.
  • The Teradata MultiLoad configuration file can also have comment statements preceded by a number sign (#) character. For detailed descriptions of the specifications listed here, see “Run‑time Parameters” on page 33.

    Configuration File Processing

    The utility automatically checks for a configuration file each time the invocation command is entered. Upon locating a configuration file, the utility sets the defaults as specified, produces the appropriate output messages, and begins processing the job.

    By default, any invalid configuration file entry or syntax error will abort the Teradata MultiLoad job immediately. The first invalid parameter will be reported, the rest of the config parameters will not be checked.

  • If CONFIGERRORS=IGNORE is specified in the config file, any subsequent config file problems will be reported but not affect the Mload return code. Mload will continue to process the next entry in the config file utility.
  • If CONFIGERRORS=TERMINATE is specified in the config file, any subsequent invalid configuration file entry will abort the Teradata MultiLoad job.
  • Note: The config file must be in the platform-appropriate single-byte character set, like ASCII or EBCDIC.