Section 5 - File Formats, Data Descriptions, MIBs, and System Processes Reference

File Formats, Data Descriptions, MIBs, and System Processes Reference

T_ULOG Class Definition

Overview

The T_ULOG class represents run-time attributes of userlog() files within an application.

Attribute Table

Table 63 TM_MIB(5): T_ULOG Class Definition Attribute Table

Attribute¹	Type	Permissions	Values	Default
`TA_LMID`(k)	string	`R--R--R--`	`LMID`	(²)
`TA_PMID`(x)	string	`R--R--R--`	`string`[1..30]	(²)
`TA_MMDDYY`(k)	long	`R--R--R--`	`mmddyy`	Current date
`TA_STATE`	string	`R--R--R--`	`GET`: `"ACT"` `SET`: N/A	N/A N/A
`TA_ULOGTIME`(k)	long	`R--R--R--`	`hhmmss`	000000
`TA_ENDTIME`(k)	long	`K--K--K--`	`hhmmss`	235959
`TA_ULOGLINE`(k)	long	`R--R--R--`	1 <= `num`	1
`TA_ULOGMSG`(x)	string	`R--R--R--`	`string`[1..256]	N/A
`TA_TPTRANID`(k)	string	`R--R--R--`	`string`[1..78]	N/A
`TA_XID`(k)	string	`R--R--R--`	`string`[1..78]	N/A
`TA_PID`(k)	long	`R--R--R--`	1 <= `num`	N/A
`TA_THREADID`	integer	`r--r--r--`	0 <= `num`	NA
`TA_CONTEXTID`(k)	long	`r--r--r--`	-2 <= `num` < 30,000	N/A
`TA_SEVERITY`(x)	string	`R--R--R--`	`string`[1..30]	N/A
`TA_ULOGCAT`(x)	string	`R--R--R--`	`string`[1..30]	N/A
`TA_ULOGMSGNUM`(k)	long	`R--R--R--`	1 <= `num`	N/A
`TA_ULOGPROCNM`(x)	string	`R--R--R--`	`string`[1..30]	N/A
(k)—`GET` key field (x)—regular expression `GET` key field

¹All attributes in the T_ULOG class are local attributes.
²TA_LMID is a required field used by the system to determine which application log file should be accessed. It is not used to restrict returned records to only those generated from processes running on the indicated machine. In cases where multiple machines share a log file via a networked filesystem, multiple TA_LMID values may be returned even though a specific value has been provided as a key field. For the same reasons, TA_PMID is not considered in directing the request to a particular machine, but is used in determining which records should be returned. In this capacity, it may be useful to leverage TA_PMID as a regular expression key field.

Attribute Semantics

TA_LMID: LMID

Retrieval machine logical machine identifier.

TA_PMID: string[1..30]

Physical machine identifier.

TA_MMDDYY: mmddyy

Date of user log file found or to be accessed.

TA_STATE:

GET: "{ACTive}"

A GET operation will retrieve run-time information for the selected T_ULOG object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request.

ACTive

The object returned reflects an existing user log file on the indicated logical machine.

SET:

SET operations are not permitted on this class.

TA_ULOGTIME: hhmmss

The time of the user log message represented by this object. The value of this attribute is formed by multiplying the hour by 10,000, adding to that the minute multiplied by 100, and finally adding in the seconds. When used as a key field, this attribute represents the start of the time range to be accessed for messages.

TA_ENDTIME: hhmmss

The latest time to be considered in a GET operation when accessing this userlog file.

TA_ULOGLINE: 1 <= num

The line number of the user log message returned/requested within the user log file. When used as a key field for retrieval, this value indicates the starting line within the log file.

TA_ULOGMSG: string[1..256]

The entire text of the user log message as it appears in the user log file.

TA_TPTRANID: string[1..78]

Transaction identifier as returned from tpsuspend(). The data in this field should not be interpreted directly by the user except for equality comparison. Messages not associated with transactions will retrieve a 0-length string as the value for this attribute.

TA_XID: string[1..78]

Transaction identifier as returned from tx_info(). The data in this field should not be interpreted directly by the user except for equality comparison. Messages not associated with transactions will retrieve a 0-length string as the value for this attribute.

TA_PID: 1 <= num

Process identifier of the client or server that generated the user log message.

TA_THREADID: 0 <= num

Identifier for the thread that wrote this user log message.

TA_CONTEXTID: -2 <= num < 30,000

Identifier for this particular application association.

TA_SEVERITY: string[1..30]

Severity of message, if any.

TA_ULOGCAT: string[1..30]

Catalog name from which the message was derived, if any.

TA_ULOGMSGNUM: 1 <= num

Catalog message number, if the message was derived from a catalog.

TA_ULOGPROCNM: string[1..30]

Process name of the client or server that generated the user log message.

Limitations

Retrievals may be done only if the associated T_MACHINE object is also ACTive.

Retrievals for this class must be directed, that is, the TA_LMID attribute must be specified. Retrievals of log records written by Workstation clients are available only if the log file used by the client is shared with one of the machines defined in the T_MACHINE class for the application. Otherwise, these log records are unavailable through this class.

Retrievals on this class which cannot be completely satisfied will always return a TA_MORE value of 1 indicating only that more information may be available for the originating request.