Chapter 4 Runtime Parameters - TARA/ABU

Teradata Archive/Recovery Utility Reference

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

When specifying Teradata ARC runtime parameters, specify PARM/DEFAULT first, then the other parameters in any order.

For z/OS systems, specify runtime parameters in ARCPARM or PARM on the EXEC card of the JCL.

Table 13 summarizes Teradata ARC runtime parameters. For more detail, refer to the sections that follow the table.

 

Table 13: Runtime Parameters 

Parameter

Platforms Supported

Description

CATALOG

All Platforms

Enables direct tape positioning for restore and copy operations

CHARSETNAME

All Platforms

Enables support of Chinese/Korean character sets when connecting to the database

CHECKPOINT

All Platforms

Places restart information in the restart log each time the specified number of data blocks are processed

CHECKSUM

All Platforms

Allows the Teradata Database and Teradata ARC to verify data packets during ARCHIVE or RESTORE

COPYSJI

All Platforms

Enables the ARC side logic to allow System Join Indexes (SJIs) to be copied to a different database

DATAENCRYPTION

All Platforms

Instructs Teradata ARC to use the payload encryption feature that is supported by Teradata Call-Level Interface (CLI)

DBSERROR

All Platforms

Allows the user to override the severity of specified error code

The new severity will determine how Teradata ARC handles the error.

DEFAULT

All Platforms

Defines the file path name that contains default options for Teradata ARC

ENCODINGCHARSET

All Platforms

Enables ARCMAIN to handle UTF16 strings when interacting with its interfaces

ERRLOG

(Specify the prefix NO to disable if previously enabled, even in the PARM file.)

All Platforms

Creates a file to store Teradata ARC execution errors

FATAL

All Platforms

Sets the program to reclassify a normally nonfatal error condition as fatal, and abend if the selected message is issued

FILEDEF

All Platforms

Maps the internal name of a file to an external name, if specified

HALT

(Specify the prefix NO to disable if previously enabled, even in the PARM file.)

All Platforms

Terminates the current task if, during archive or recovery, the Teradata Database fails or restarts, and the new configuration differs from the configuration that preceded the failure

HEX

(Specify the prefix NO to disable if previously enabled, even in the PARM file.)

All Platforms

Displays object names in the standard output in hexadecimal notation

IOMODULE

Linux,
Windows XP/Server 2003

Specifies the name of an access module

Note: The value of IOMODULE is passed directly to the tape access module. ARCMAIN does not interpret the value.

IOPARM

Linux,
Windows XP/Server 2003

Specifies the initialization string for the access module named in IOMODULE

Note: The value of IOPARM is passed directly to the access module. ARCMAIN does not interpret the value.

LINEWRAP

All Platforms

Specifies the number of characters at which Teradata ARC wraps lines on its output log

LOGON

All Platforms

Enables the runtime definition of the logon string

LOGSKIPPED

All Platforms

Instructs Teradata ARC to log all of the tables that are skipped during an ARCHIVE operation

NOTMSM

All Platforms except mainframe (IBM z/OS)

Turns off Teradata Multi-System Manager (TMSM) event logging

NOWARN

All Platforms

Allows the user to override the severity of specified warning error codes to Info (severity 0)

The new severity will determine how Teradata ARC will handle the warning.

OUTLOG

Windows XP/Server 2003

Duplicates standard (stdout) output to a file

PARM

IBM z/OS

Specifies that frequently used runtime parameters are in a parameter file

Important: This parameter must be first when other parameters are specified.

PAUSE

(Specify the prefix NO to disable if previously enabled, even in the PARM file.)

All Platforms

Pauses execution if, during archive or recovery, the Teradata Database fails or restarts, and the new configuration differs from the configuration that preceded the failure

PERFFILE

All Platforms

Provides a performance logging option for Teradata ARC to export performance data for job analysis

RESTART

(Specify the prefix NO to disable if previously enabled, even in the PARM file.)

All Platforms

Specifies the current operation is a restart of a previous operation that was interrupted by a client failure

RESTARTLOG

All Platforms

Specifies the restart log name for ARCMAIN

SESSIONS

All Platforms

Specifies the number of Teradata sessions available for archive and recovery operations

STARTAMP

All Platforms

Specifies a starting AMP for an all-AMPs archive rather than starting on a random AMP or starting with AMP0

UEN (Utility Event Number)

Windows XP/Server 2003

Specifies the value that will be used to define %UEN% when in a RESTORE/COPY operation

VERBOSE

(Specify the prefix NO to disable if previously enabled, even in the PARM file.)

All Platforms

Sends Teradata ARC progress status information to the standard output device (for example, SYSPRINT for IBM platforms)

WORKDIR

Windows XP/Server 2003

Specifies the name of the working directory