17.00 - Mainframe-Attached Systems Using the 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 mainframe session being reported, such as the user ID or session number of the client system. LogonSource can contain the following names and identifiers.

Unless otherwise noted, each of the LogonSource string fields contains eight characters.

Field Name Description
Operating System Name

(Field 1)

Name of the client operating system for this logon.

The valid name is MVS.

TDP ID

(Field 2)

Unique identifier for the mainframe TDP controlling this logon.
Job Name

(Field 3)

This is the job name.
Environment Name

(Field 4)

The valid environments are BATCH, CICS, IMS, and TSO.
User ID from Security Product

(Field 5)

This is the user ID provided by the security product in use.
If no security product is in use, this is blank.
Group from Security Product

(Field 6)

This is the group ID provided by the security product in use.

If no security product is in use, this is blank.

Program Name

(Field 7)

Use of this field is deprecated because it is not possible to determine whether it specifies an executable application name or a unique identifier provided by an application using the CLIv2 Workload specification (see Teradata® Call-Level Interface Version 2 Reference for Mainframe-Attached Systems, B035-2417).

Instead, you should use the Actual Program Name field, which provides a reliable name for the executable application

Coordinator Name

(Field 8)

Name of the Coordinator if the logon is part of a two-phase commit logon.

This is used only by the CICS and IMS mainframe transaction managers; otherwise, it is blank.

Transaction ID

(Field 9)

Unique identifier for the transaction as determined by the transaction manager.

This is used only by the CICS and IMS mainframe transaction managers; otherwise, it is blank.

Terminal ID

(Field 10)

Unique identifier for the terminal as determined by CICS.

This is used only for CICS; otherwise, it is blank.

User/Operator ID

(Field 11)

Unique identifier for the user or operator as determined by CICS.

This is used only for CICS; otherwise, it is blank.

Actual Program Name

(Field 12)

This field contains the name of the executable application.
Job ID

(Field 13)

This field contains the job ID.
Format ID

(Field 14)

Format identifier that can be used to parse the earlier positional information in the LogonSource attribute. If the field ends with the following four characters, the format ID is present:
LSS
In the example above, the first character of the four character format ID is a blank space.

The first set of two characters indicate the number of values found before the Actual Program Name, which is either 07 or 11.

The second set of two characters indicates the version of the format ID.

If the value is 01, the field contains the Job ID.

If the value is 02, the field contains both the Actual Program Name and the Job ID value.

If no Format ID is present, no Job ID value exists and only the first 7 or 11 fields of the LogonSource string are present.

Self-Defining EBCDIC Items

(Field 15 or later)

The following self-defining EBCDIC items have variable lengths and contain the specified information within the parentheses that follow the field name in the LogonSource string:
  • TDP(): TDP release ID. See Teradata® Director Program Reference, B035-2416.
  • CL2(): CLIv2 release ID. See Teradata® Call-Level Interface Version 2 Reference for Mainframe-Attached Systems, B035-2417.
  • SESSDESC(): Descriptive information specified by the application using the CLIv2 Session-desc specification. See Teradata® Call-Level Interface Version 2 Reference for Mainframe-Attached Systems, B035-2417.
  • WORKLOAD(): Information specified by the application using the CLIv2 Workload specification. The information is intended to be used by Vantage. See Teradata® Call-Level Interface Version 2 Reference for Mainframe-Attached Systems, B035-2417.
If the length of the self-defining items causes the LogonSource string to exceed 128 characters, Vantage truncates them as necessary and indicates the truncation with the string ‘…)’ if enough space remains to do so.