FastExport Configuration File - 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
Use a FastExport configuration file to set the initial default values for the following operating parameters when FastExport is invoked:
  • CHARSET
  • ERRLOG
  • BRIEF
  • MAXSESS
  • MINSESS
  • STATUS
  • DATAENCRYPTION
  • CONFIGERRORS
  • RETRYFIRSTCONNECT
  • RETRYOTHERCONNECT
  • RETRYCONNECTINTERVAL

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 FastExport configuration file override the internal utility default values for these parameters.

The configuration file parameters themselves can be overridden by the commands in the FastExport job script, and by the corresponding runtime parameters, as shown in Runtime Parameters for Network-Attached Systems. The order of preference for these parameters, from highest to lowest, is:

  • 1 – FastExport script commands
  • 2 – Runtime parameters
  • 3 – FastExport configuration file specifications
  • 4 – FastExport default values

Configuration File Name and Location

On network-attached systems, the FastExport configuration file must be named fexpcfg.dat

The file must be located in either:

  • The directory from which FastExport is launched
  • The directory specified in the FEXPLIB environment variable

On mainframe-attached systems, the DD statement for the FastExport configuration file must be labeled FEXPCFG.

Configuration File Contents

The FastExport configuration file can have up to eight entries, one for each parameter:

CHARSET=character-set-name
ERRLOG=filename
BRIEF=on/off
MAXSESS=max-sessions
MINSESS=min-sessions
STATUS=ON/OFF
DATAENCRYPTION=ON/OFF
CONFIGERRORS=IGNORE/TERMINATE

RETRYFIRSTCONNECT=n
RETRYOTHERCONNECT=n
RETRYCONNECTINTERVAL=s
where the following is true:
  • character-set-name is the character set specification for the FastExport job
  • filename is the alternate file specification for FastExport error messages
  • BRIEF on/off configures the reduced print output specification for the FastExport job
  • max-sessions is the MAXSESS specification for the maximum number of FastExport sessions logged on to Teradata Database
  • min-sessions is the MINSESS specification for the minimum number of FastExport sessions required to run the job
  • STATUS ON/OFF specifies the five-minute status reporting for the FastExport job
  • DATAENCRYPTION ON/OFF specifies the data encryption option for the FastExport job
  • IGNORE/TERMINATE configures the option for the FastExport configuration file error handling
  • n specified for RETRYFIRSTCONNECT is the maximum number of connection retries when FastExport 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 FastExport 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 FastExport configuration file can also have comment statements preceded by a number sign (#) character.

For a complete description of the parameter specifications listed here, see Runtime Parameters for Mainframe-Attached Systems and Runtime Parameters for Network-Attached Systems.

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 immediately aborts a job. The first invalid parameter will be reported; none of the other configuration parameters are checked.
  • If CONFIGERRORS=IGNORE is specified, any subsequent configuration file problems will be reported, but they will not affect the return code. The utility will continue to process the next entry in the configuration file.
  • If CONFIGERRORS=TERMINATE is specified, any subsequent invalid configuration file entry will abort the job.

If no configuration file exists, the utility begins processing the job without indicating an error. The configuration file is an optional feature of FastExport, and its absence is not considered an error condition.

The config file must be in the platform-appropriate single-byte character set, like ASCII or EBCDIC.