KBML properties

The list below shows the various KBML properties.

address
The "primary" IP address of the device, if any. Devices can have multiple IP addresses, in which case the value chosen as the "primary" IP address is somewhat arbitrary. For example, ${device.address} might produce a value such as 172.16.67.12.
  • Defined on KBML Type: Device, Db2Dbms, Db2ObjectUsage, Db2SqlStatement, Dbms, Device, Domain, DomainElement, DynamicDb2SqlStatement, SelfElement, Software, Sql, SqlStatment
  • Type: IPAddress
  • Identifier: device, subject
autoClear
How long the alert will stay on the message board after its initial posting.
  • Defined on KBML Type: Managed event
  • Type: Number
  • Identifier: event
bestName
DomainElements might have several different names, depending upon the type of DomainElement. "bestName" is based up the name that is considered to be the most identifying for that DomainElement while still attempting to be somewhat concise.
  • Defined on KBML Type: Device, Db2Dbms, Db2ObjectUsage, Db2SqlStatement, Dbms, Device, Domain, DomainElement, DynamicDb2SqlStatement, SelfElement, Software, Sql, SqlStatment
  • Type: String
  • Identifier: subject
collectionId
The collection ID associated with the SQL statement.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
count
The count or numerator of the rate.
  • Defined on KBML Type: Rate
  • Type: Number
customName
Not applicable to Query Monitor.
datetime
The initial time of the event, as a Date object.
  • Defined on KBML Type: ManagedEvent
  • Type: Date
  • Identifier: event
db2Dbms
The Db2 subsystem from which the alert was generated.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: Db2Dbms
  • Identifier: subject
db2Ssid
The Db2 subsystem ID on which the alert for this SQL Statement was generated.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
dbms
The Db2 subsystem from which the alert was generated.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement, SqlStatement
  • Type: Dbms
  • Identifier: subject
definitionName
Not applicable to Query Monitor.
displayName
Same as event.type.
  • Defined on KBML Type: ManagedEvent
  • Type: String
  • Identifier: event
dnsName
Not applicable to Query Monitor.
domain
Not applicable to Query Monitor.
domainElement
Any kind of 'thing' that can have an event about it: a Device, SqlStatement, Db2Dbms, Db2ObjectUsage.
  • Defined on KBML Type: ManagedEvent
  • Type: DomainElement
  • Identifier: event
escalationRate
The rate at which the event will increase in priority if left unacknowledged.
  • Type: String
  • Identifier: event
id
The unique identifier of the alert. Can be used to build a URL to the message details.
  • Defined on KBML Type: ManagedEvent
  • Type: long
  • Identifier: event
ignoreEvent
Whether or not events of this type are to be ignored and never posted.
  • Defined on KBML Type: ManagedEvent
  • Type: boolean
  • Identifier: event
initialPriority
The initial priority of the alert when it was posted on the message board.
  • Type: int
  • Identifier: event
isAcknowledged
Indicates whether or not the alert has been acknowledged.
  • Defined on KBML Type: ManagedEvent
  • Type: boolean
  • Identifier: event
length
The number of characters in a String.
  • Type: int
  • Identifier: domainName, trigger, userName
markedToDelete
Not applicable to Query Monitor.
message
The message that appears on the message board for this alert.
  • Defined on KBML Type: ManagedEvent
  • Type: String
  • Identifier: event
name
Not applicable to Query Monitor.
persist
Indicates whether this event, if not cleared, will be backed up on disk to be restored when the server restarts.
  • Type: Boolean
  • Identifier: event
plan
The plan under which this SQL statement was executed.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
priority
The current priority of the alert.
  • Defined on KBML Type: ManagedEvent
  • Type: int
  • Identifier: event
productName
Not applicable to Query Monitor.
productVersion
Not applicable to Query Monitor.
programName
If the SQL statement was bound in a package, the package name, otherwise the DBRM name.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
programVersion
For static sql, the version of the program under which it was bound.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
rate
The rate at which something happens: delta(count)/timePeriod.
  • Defined on KBML Type: Event
  • Type: int
  • Identifier: event
recurrenceThreshold
Number of times the alert must occur before it will be posted to the message board.
  • Type: int
  • Identifier: event
repetitionCount
Number of times the same kind of event has occurred for the same "thing".
  • Defined on KBML Type: ManagedEvent
  • Type: int
  • Identifier: event
sectionNumber
The section number with which the displayed activity is associated.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: int
  • Identifier: subject
serialNumber
Not applicable to Query Monitor.
sourceAddress
Not applicable to Query Monitor.
ssid
The Db2 subsystem ID.
  • Defined on KBML Type: Db2Dbms
  • Type: String
  • Identifier: event
statementNumber
Not applicable to Query Monitor.
status
Not applicable to Query Monitor.
subjectAddress
Not applicable to Query Monitor.
summary
Same as event.message.
  • Defined on KBML Type: ManagedEvent
  • Type: String
  • Identifier: event
supervised
Not applicable to Query Monitor.
timeperiod
The time period over which the rate is calculated.
  • Defined on KBML Type: Rate
  • Type: TimePeriod
  • Identifier: event
timestamp
The initial time of the event, in milliseconds.
  • Defined on KBML Type: ManagedEvent
  • Type: long
  • Identifier: event
type
The specific kind of event.
  • Defined on KBML Type: ManagedEvent
  • Type: Object
  • Identifier: event
uid
The unique (within the server) ID for this DomainElement.
  • Defined on KBML Type: Device, Db2Dbms, Db2ObjectUsage, Db2SqlStatement, Dbms, SelfElement, Software, Sql, SqlStatement, DynamicDb2SqlStatement
  • Type: long
  • Identifier: subject
user
The userid under which the SQL statement was run.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
winsName
Not applicable to Query Monitor.
workload
The CQM collector profile workload whose threshold triggered the alert.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
wsName
The workstation name.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
wsTran
The workstation transaction ID.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject
wsUser
The workstation user.
  • Defined on KBML Type: Db2SqlStatement, DynamicDb2SqlStatement
  • Type: String
  • Identifier: subject