Required and Optional Attributes - Parallel Transporter

Teradata® Parallel Transporter Reference
Product
Parallel Transporter
Release Number
17.10
Published
February 2022
Language
English (United States)
Last Update
2023-11-29
dita:mapPath
abr1608578396711.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
ogv1478610452101
Product Category
Teradata Tools and Utilities

Use the attribute definition list syntax in the Teradata PT DEFINE OPERATOR statement to declare the required and optional attribute values for the OS Command operator.



where:

OS Command Operator Attribute Descriptions 
Syntax Element Description
CmdType='option' Optional attribute that specifies the command type (only for IBM z/OS).

Valid values are:

  • ‘tso’
  • ‘uss’

If nothing is specified, ‘uss’ is the default.

The argument can be a single VARCHAR (‘tso’ or ‘uss’) or an array VARCHAR ([‘tso’, ‘uss’]).

The following is invalid: [, ‘uss’, , ‘tso’].
IgnoreError = 'option' Optional attribute that specifies whether to ignore an error returned from the operating system or to terminate.

Valid values are:

  • 'Yes' (or 'Y') = continue the Teradata PT job when an error returns from the execution of the operating system execution (default).
  • 'No' (or 'N') = terminate the Teradata PT job when an error returns from the execution of the operating system.
The VARCHAR ARRAY can specify more than one value. For example:
  • VARCHAR IgnoreError = 'YES'
  • VARCHAR IgnoreError = 'NO'
  • VARCHAR ARRAY IgnoreError = [ 'YES' ]
  • VARCHAR ARRAY IgnoreError = [ 'YES', 'NO' ]

When used as the above case, the condition corresponds to the number of the command used in the ARRAY OsCmd attribute.
PrivateLogName = 'logName' Optional attribute that specifies the name of a log that is maintained by the Teradata PT Logger inside the public log. The private log contains all of the output provided by the operator.

The private log can be viewed using the tlogview command as follows, where jobId is the Teradata PT job name and privateLogName is the value for the operator’s PrivateLogName attribute:

tlogview -j jobid -f privatelogname

If the private log is not specified, all output is stored in the public log.

For more information about the tlogview command, see Teradata PT Utility Commands.
TraceLevel = 'level' Optional attribute that specifies the types of diagnostic messages that are written by each instance of the operator to the to the public log (or private log, if one is specified using the PrivateLogName attribute). The diagnostic trace function provides more detailed information in the log file to aid in problem tracking and diagnosis.

The trace levels are:

  • 'None' = TraceLevel turned off (default).
  • 'PX' = enables the tracing function for activities related to the Teradata PT infrastructure
  • 'Oper' = enables the tracing function for operator-specific activities
  • 'All' = enables tracing for all of the above activities

The VARCHAR ARRAY can specify more than one value, for example:

VARCHAR TraceLevel = 'PX'
VARCHAR TraceLevel = 'OPER'
VARCHAR ARRAY TraceLevel = [ 'PX' ]
VARCHAR ARRAY TraceLevel = [ 'PX', 'OPER' ]
The TraceLevel attribute is provided as a diagnostic aid only. The amount and type of additional information provided by this attribute changes to meet evolving needs from release to release.
VARCHAR Keyword that specifies VARCHAR as the data type of the defined attribute.