Elements

The probe breaks event data down into tokens and parses them into elements. Elements are used to assign values to ObjectServer fields; the field values contain the event details in a form that the ObjectServer understands.

The following table describes the elements that the probe generates. Not all the elements described are generated for each event. The elements that the probe generates depend on the event type.

Table 1. Elements

Element name

Element description

$additionalInfo

This element provides additional information about the alarm.

$additionalText

This element contains a brief description of the problem being reported by the alarm.

$affectedTPList

This element indicates whether the list of termination points affected by the problem is reported by the alarm.

$domain_name

This element shows the domain where the event occurred.

$emsTime

This element displays the time at which the alarm was reported by CTM.

$event_type

This element indicates the type of the alarm. Possible values are:
  • communicationsAlarm
  • environmentalAlarm
  • equipmentAlarm
  • processingErrorAlarm
  • qualityofServiceAlarm

$event_name

This element shows the name of the event.

$isClearable

This element indicates whether or not the alarm can be cleared. Possible values are:
  • true
  • false

$layerRate

This element identifies the layer to which the alarm applies.

$nativeEMSName

This element shows the name of the object reporting the alarm as given in the CTM user interface.

$nativeProbableCause

This element indicates the probable cause as given in the CTM user interface.

$neTime

This element shows the time at which the error occurred in the network element.

$notificationId

This element contains the unique identifier of the alarm. This is derived from the serial number of the alarm as used by CTM.

$objectName

This element shows the name of the object reporting the alarm.

$objectType

This element shows the type of object reporting the alarm.

$perceivedSeverity

This element indicates the perceived severity of the alarm.

$probableCause

This element identifies the probable cause of the alarm.

$probableCauseQualifier

This element contains the qualifier used to classify the alarm type.

$serviceAffecting

This element indicates whether or not the alarm has affected the service.