17.00 - Workstation-Attached Systems Using CLIv2 API - Teradata Database

Teradata Vantageā„¢ - Data Dictionary

prodname
Advanced SQL Engine
Teradata Database
vrm_release
17.00
created_date
June 2020
category
Administration
Programming Reference
featnum
B035-1092-170K

The origin of the CLIv2 workstation-attached session being reported, such as the user ID or session number of the client system.

The corresponding LogOnOffV[X] or SessionInfoV[X] column shown in the table below appears in the LogOnOffV[X] and SessionInfoV[X] views and EventLog and SessionTbl tables only.

Teradata strongly recommends that applications which use the LogonSource fields instead use the corresponding LogOnOffV[X] or SessionInfoV[X] columns, also referred to as ClientAttribute columns.

You can use Teradata Studio or Teradata Studio Express to learn more about the ClientAttribute columns.

Field Name Description Corresponding LogOnOffV[X] or SessionInfoV[X] Column Description
Mode

(Field 1)

The literal string indicating the connection type, for example:
TCP/IP

This field is always 8 characters long.

This information is provided by the gateway.

ClientConnectionType Value is 1 indicating the client is connected using TCP/IP via the gateway.

To learn more about the possible values for this column see Possible Values for ClientConnectionType or you can use Teradata Studio or Teradata Studio Express.

TCP Port or Socket Number

(Field 2)

Hexadecimal TCP port or socket number on the workstation-attached client system.

This field contains 4 hexadecimal characters.

The maximum value is 64K -1

This information is provided by the gateway.

ClientTcpPortNumber Integer value of the TCP port or socket number.
IP Address

(Field 3)

IP address of the workstation-attached client system.

This field contains a maximum of 45 characters.

This information is provided by the gateway.

ClientIpAddress Standard string representation of the IPv4 or IPv6 IP address.
TDP ID

(Field 4)

Unique ID for the network TDP controlling this logon.

The number of characters depends on the value for the TDP ID that was specified when you logged on.

ClientTdHostName Vantage host name that the client used to connect to Vantage.
Client Process ID

(Field 5)

ID for the process on the workstation-attached client system.

This field contains a maximum of 10 decimal digits.

ClientProcThreadId Client process or thread ID.
Client User ID

(Field 6)

User ID for the logged on user as defined for the workstation-attached client system.

This field contains a maximum of 92 characters.

ClientSystemUserId Client user ID.
Client Program

(Field 7)

ID for the CLIv2-based client program.

This field contains a maximum of 256 characters.

ClientProgramName Client system program name.
LSINFO

(Field 9)

Optional text derived from the LSINFO environment variable.

The size of LSINFO depends on how many characters remain available in LogonSource after fields 1 through 8 have been assembled.

If the size of LSINFO exceeds the remaining space in LogonSource, CLIv2 truncates the data to fit the available space.

ClientJobData Client job data from the LSINFO environmental variable.