17.20 - Put Attribute Requests - Access Module

Teradata® Tools and Utilities Access Module Programmer Guide

Access Module
Release Number
June 2022
English (United States)
Last Update

In response to a Put Attribute request, which includes a value for an attribute previously defined by the Teradata utility, an Access Module must respond with a return code indicating whether the attribute name was recognized. This is a passive function, meaning that an Access Module can only receive the value of the provided information. An Access Module cannot actively retrieve information from a Teradata utility.

For example, if a Teradata utility needs to provide an Access Module with the value of several attributes that describe its state of operation (such as DBSVersion, ClientState, CurrDBS, or CurrTable), the Teradata utility can perform a Put Attribute function whenever one of these attributes is first defined or changed. The Access Module then receives each Put Attribute request and responds each time, indicating whether the attribute name was recognized.

If an attribute that is needed by an Access Module is not already defined by a Put Attribute function from the client utility, the Access Module might fail, in which case it will respond with an appropriate return code and error message.